New Relic API

Use these operations to interact with the New Relic integration in Cortex.

Required permissions

Your API key must have the Configure integrations permission.

Operations

Retrieve configurations

get

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/newrelic/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

{
  "configurations": [
    {
      "accountId": 1,
      "alias": "text",
      "isDefault": true,
      "lastFour": "text",
      "region": "US"
    }
  ]
}

Retrieve default configuration

get

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/newrelic/default-configuration HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

{
  "accountId": 1,
  "alias": "text",
  "isDefault": true,
  "lastFour": "text",
  "region": "US"
}

Retrieve a configuration

get

Authorizations

Path parameters

aliasstringRequired

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/newrelic/configuration/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

{
  "accountId": 1,
  "alias": "text",
  "isDefault": true,
  "lastFour": "text",
  "region": "US"
}

Add multiple configurations

post

Authorizations

Body

Responses

post

HTTPcURLJavaScriptPython

POST /api/v1/newrelic/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "configurations": [
    {
      "accountId": 1,
      "alias": "text",
      "isDefault": true,
      "personalKey": "text",
      "region": "US"
    }
  ]
}

{
  "configurations": [
    {
      "accountId": 1,
      "alias": "text",
      "isDefault": true,
      "lastFour": "text",
      "region": "US"
    }
  ],
  "skippedConfigurations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Add a single configuration

post

Authorizations

Body

accountIdinteger · int32Required

aliasstringRequired

isDefaultbooleanRequired

personalKeystringRequired

regionstring · enumRequiredPossible values:

Responses

post

HTTPcURLJavaScriptPython

POST /api/v1/newrelic/configuration HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "accountId": 1,
  "alias": "text",
  "isDefault": true,
  "personalKey": "text",
  "region": "US"
}

{
  "configurations": [
    {
      "accountId": 1,
      "alias": "text",
      "isDefault": true,
      "lastFour": "text",
      "region": "US"
    }
  ]
}

Validate all configurations

post

Authorizations

Responses

post

HTTPcURLJavaScriptPython

POST /api/v1/newrelic/configuration/validate HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

{
  "configurations": [
    {
      "alias": "text",
      "isValid": true,
      "message": "text"
    }
  ]
}

Validate a configuration

post

Authorizations

Path parameters

aliasstringRequired

Responses

post

HTTPcURLJavaScriptPython

POST /api/v1/newrelic/configuration/validate/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

{
  "alias": "text",
  "isValid": true,
  "message": "text"
}

Update a configuration

put

WARNING: Updating aliases for configurations or changing the default configuration could cause entity YAMLs that use this integration to break.

Authorizations

Path parameters

aliasstringRequired

Body

aliasstringRequired

isDefaultbooleanRequired

Responses

put

HTTPcURLJavaScriptPython

PUT /api/v1/newrelic/configuration/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "alias": "text",
  "isDefault": true
}

{
  "configurations": [
    {
      "accountId": 1,
      "alias": "text",
      "isDefault": true,
      "lastFour": "text",
      "region": "US"
    }
  ]
}

Delete all configurations

delete

Authorizations

Responses

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/newrelic/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

Delete a configuration

delete

Authorizations

Path parameters

aliasstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/newrelic/configuration/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

{
  "configurations": [
    {
      "accountId": 1,
      "alias": "text",
      "isDefault": true,
      "lastFour": "text",
      "region": "US"
    }
  ]
}