Azure Resources API

Use these operations to interact with the Azure Resources integration in Cortex.

Required permissions

Your API key must have the Configure integrations permission.

Operations

List Azure Resources types

get

Authorizations

Query parameters

includeDisabledboolean · default: falseoptional

Whether to include disabled Azure Resources types

pageSizeinteger · int32 · default: 250required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger · int32 · default: 0required

Page number to return, 0-indexed. Default 0.

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/azure-resources/types?pageSize=1&page=1' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

{
  "hasMore": true,
  "page": 1,
  "total": 1,
  "totalPages": 1,
  "types": [
    {
      "enabled": true,
      "type": "microsoft.policyinsights/policyevents"
    }
  ]
}

Successfully found Azure Resources types

Retrieve configurations

get

Authorizations

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/azure-resources/configurations' \
  --header 'Authorization: Bearer JWT'

200

400

429

200

{
  "configurations": [
    {
      "alias": "text",
      "azureTenantId": "text",
      "clientId": "text",
      "isDefault": true,
      "lastFour": "text",
      "subscriptionId": "text"
    }
  ]
}

Successfully found configurations

Retrieve default configuration

get

Authorizations

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/azure-resources/default-configuration' \
  --header 'Authorization: Bearer JWT'

200

400

429

200

{
  "alias": "text",
  "azureTenantId": "text",
  "clientId": "text",
  "isDefault": true,
  "lastFour": "text",
  "subscriptionId": "text"
}

Successfully found default configuration

Retrieve a configuration

get

Authorizations

Path parameters

aliasstringrequired

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/azure-resources/configuration/{alias}' \
  --header 'Authorization: Bearer JWT'

200

400

404

429

200

{
  "alias": "text",
  "azureTenantId": "text",
  "clientId": "text",
  "isDefault": true,
  "lastFour": "text",
  "subscriptionId": "text"
}

Successfully found configuration

Add a single configuration

post

Authorizations

Body

aliasstringrequired

azureTenantIdstringrequired

clientIdstringrequired

clientSecretstringrequired

isDefaultbooleanrequired

subscriptionIdstringrequired

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/azure-resources/configuration' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "alias": "text",
    "azureTenantId": "text",
    "clientId": "text",
    "clientSecret": "text",
    "isDefault": true,
    "subscriptionId": "text"
  }'

200

400

403

429

200

{
  "configurations": [
    {
      "alias": "text",
      "azureTenantId": "text",
      "clientId": "text",
      "isDefault": true,
      "lastFour": "text",
      "subscriptionId": "text"
    }
  ]
}

Successfully added configuration

Validate all configurations

post

Authorizations

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/azure-resources/configuration/validate' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

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

Successfully validated all configurations

Validate a configuration

post

Authorizations

Path parameters

aliasstringrequired

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/azure-resources/configuration/validate/{alias}' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

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

Successfully validated configuration

Add multiple configurations

post

Authorizations

Body

configurationsobject[]required

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/azure-resources/configurations' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "configurations": [
      {
        "alias": "text",
        "azureTenantId": "text",
        "clientId": "text",
        "clientSecret": "text",
        "isDefault": true,
        "subscriptionId": "text"
      }
    ]
  }'

200

403

429

200

{
  "configurations": [
    {
      "alias": "text",
      "azureTenantId": "text",
      "clientId": "text",
      "isDefault": true,
      "lastFour": "text",
      "subscriptionId": "text"
    }
  ],
  "skippedConfigurations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Successfully added configurations

Update configured Azure Resources types

put

Authorizations

Body

typesobject[]required

List of Azure Resources types and whether they're configured to be discovered and imported into the catalogs

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/azure-resources/types' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "types": [
      {
        "enabled": true,
        "type": "microsoft.policyinsights/policyevents"
      }
    ]
  }'

200

400

404

429

200

{
  "hasMore": true,
  "page": 1,
  "total": 1,
  "totalPages": 1,
  "types": [
    {
      "enabled": true,
      "type": "microsoft.policyinsights/policyevents"
    }
  ]
}

Successfully replaced Azure Resources types

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

application/json

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/azure-resources/configuration/{alias}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "alias": "text",
    "isDefault": true
  }'

200

400

403

404

429

200

{
  "configurations": [
    {
      "alias": "text",
      "azureTenantId": "text",
      "clientId": "text",
      "isDefault": true,
      "lastFour": "text",
      "subscriptionId": "text"
    }
  ]
}

Successfully updated configuration

Delete all configurations

delete

Authorizations

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/azure-resources/configurations' \
  --header 'Authorization: Bearer JWT'

200

400

403

429

200

No body

Successfully deleted all configurations

Delete a configuration

delete

Authorizations

Path parameters

aliasstringrequired

Responses

application/json

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/azure-resources/configuration/{alias}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

429

200

{
  "configurations": [
    {
      "alias": "text",
      "azureTenantId": "text",
      "clientId": "text",
      "isDefault": true,
      "lastFour": "text",
      "subscriptionId": "text"
    }
  ]
}

Successfully deleted configuration