AWS API

Use these operations to interact with the AWS integration in Cortex.

Required permissions

Your API key must have the Configure integrations permission.

Operations

List AWS types

get

Authorizations

Query parameters

includeDisabledboolean · default: falseoptional

When true, includes all AWS types supported

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/aws/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": "AWS::S3::Bucket"
    }
  ]
}

Successfully found AWS types

Retrieve a configuration

get

Authorizations

Path parameters

accountIdstringrequired

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/aws/configurations/{accountId}' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

{
  "accountId": "text",
  "accountName": "text",
  "role": "text"
}

Successfully found configuration

Retrieve configurations

get

Authorizations

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

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

200

429

200

{
  "configurations": [
    {
      "accountId": "text",
      "accountName": "text",
      "role": "text"
    }
  ]
}

Successfully found configurations

Add a single configuration

post

Authorizations

Body

accountIdstringrequired

The account ID for the AWS account

rolestringrequired

The IAM role Cortex would be assuming

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/aws/configurations' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": "text",
    "role": "text"
  }'

200

400

403

429

200

{
  "accountId": "text",
  "accountName": "text",
  "role": "text"
}

Successfully added configuration

Validate all configurations

post

Authorizations

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/aws/configurations/all/validate' \
  --header 'Authorization: Bearer JWT'

200

429

200

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

Successfully validated all configurations

Validate a configuration

post

Authorizations

Path parameters

accountIdstringrequired

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/aws/configurations/validate/{accountId}' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

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

Successfully validated configuration

Update configurations

put

Authorizations

Body

configurationsobject[]required

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/aws/configurations' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "configurations": [
      {
        "accountId": "text",
        "role": "text"
      }
    ]
  }'

200

400

403

429

200

{
  "configurations": [
    {
      "accountId": "text",
      "accountName": "text",
      "role": "text"
    }
  ]
}

Successfully replaced configurations

Update configured AWS types

put

Authorizations

Body

typesobject[]required

List of AWS 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/aws/types' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "types": [
      {
        "enabled": true,
        "type": "AWS::S3::Bucket"
      }
    ]
  }'

200

400

403

429

200

{
  "types": [
    {
      "enabled": true,
      "type": "AWS::S3::Bucket"
    }
  ]
}

Successfully replaced AWS types

Delete all configurations

delete

Authorizations

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

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

200

403

429

200

No body

Successfully deleted configurations

Delete a configuration

delete

Authorizations

Path parameters

accountIdstringrequired

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/aws/configurations/{accountId}' \
  --header 'Authorization: Bearer JWT'

200

403

404

429

200

No body

Successfully deleted configuration