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

Last updated 1 month ago

List AWS types

get

Authorizations

Query parameters

includeDisabledbooleanOptional

When true, includes all AWS types supported

Default: false

pageSizeinteger · int32Required

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

Default: 250

pageinteger · int32Required

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

Default: 0

Responses

get

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

{
  "hasMore": true,
  "page": 1,
  "total": 1,
  "totalPages": 1,
  "types": [
    {
      "enabled": true,
      "type": "AWS::S3::Bucket"
    }
  ]
}

Retrieve a configuration

get

Authorizations

Path parameters

accountIdstringRequired

Responses

get

GET /api/v1/aws/configurations/{accountId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

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

Retrieve configurations

get

Authorizations

Responses

get

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

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

Validate all configurations

post

Authorizations

Responses

post

POST /api/v1/aws/configurations/all/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

accountIdstringRequired

Responses

post

POST /api/v1/aws/configurations/validate/{accountId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

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

Delete all configurations

delete

Authorizations

Responses

delete

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

No content

Delete a configuration

delete

Authorizations

Path parameters

accountIdstringRequired

Responses

delete

DELETE /api/v1/aws/configurations/{accountId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

Add a single configuration

post

Authorizations

Body

accountIdstringRequired

The account ID for the AWS account

rolestringRequired

The IAM role Cortex would be assuming

Responses

post

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

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

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

Update configurations

put

Authorizations

Body

Responses

put

PUT /api/v1/aws/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 55

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

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

Update configured AWS types

put

Authorizations

Body

Responses

put

PUT /api/v1/aws/types HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 53

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

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