Login to CortexBook a DemoCortex Academycortex.ioCortex Status

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
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
200
Successfully found AWS types
application/json
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
200
Successfully found configuration
application/json
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
200
Successfully found configurations
application/json
get
GET /api/v1/aws/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

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

Add a single configuration

post
Authorizations
Body
accountIdstringRequired

The account ID for the AWS account

rolestringRequired

The IAM role Cortex would be assuming

Responses
200
Successfully added configuration
application/json
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"
}

Validate all configurations

post
Authorizations
Responses
200
Successfully validated all configurations
application/json
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
200
Successfully validated configuration
application/json
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"
}

Update configurations

put
Authorizations
Body
Responses
200
Successfully replaced configurations
application/json
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
200
Successfully replaced AWS types
application/json
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"
    }
  ]
}

Delete all configurations

delete
Authorizations
Responses
200
Successfully deleted configurations
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
200
Successfully deleted configuration
delete
DELETE /api/v1/aws/configurations/{accountId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

Last updated

Was this helpful?