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
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
When true, includes all AWS types supported
falseNumber of results to return per page, between 1 and 1000. Default 250.
250Page number to return, 0-indexed. Default 0.
0Successfully found AWS types
AWS types not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/aws/types?pageSize=250&page=0 HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"hasMore": true,
"page": 1,
"total": 1,
"totalPages": 1,
"types": [
{
"enabled": true,
"type": "AWS::S3::Bucket"
}
]
}All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Successfully found configuration
Configuration not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/aws/configurations/{accountId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"accountId": "text",
"accountName": "text",
"role": "text"
}All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Successfully found configurations
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/aws/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"configurations": [
{
"accountId": "text",
"accountName": "text",
"role": "text"
}
]
}All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
The account ID for the AWS account
The IAM role Cortex would be assuming
Successfully added configuration
Bad Request
Forbidden
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/aws/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"accountId": "text",
"role": "text"
}{
"accountId": "text",
"accountName": "text",
"role": "text"
}All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Successfully validated all configurations
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/aws/configurations/all/validate HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"configurations": [
{
"alias": "text",
"isValid": true,
"message": "text"
}
]
}All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Successfully validated configuration
Configuration not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/aws/configurations/validate/{accountId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"alias": "text",
"isValid": true,
"message": "text"
}All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Successfully replaced configurations
Bad Request
Forbidden
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
PUT /api/v1/aws/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55
{
"configurations": [
{
"accountId": "text",
"role": "text"
}
]
}{
"configurations": [
{
"accountId": "text",
"accountName": "text",
"role": "text"
}
]
}All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Successfully replaced AWS types
Bad Request
Forbidden
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
PUT /api/v1/aws/types HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"types": [
{
"enabled": true,
"type": "AWS::S3::Bucket"
}
]
}{
"types": [
{
"enabled": true,
"type": "AWS::S3::Bucket"
}
]
}All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Successfully deleted configurations
Forbidden
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
DELETE /api/v1/aws/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Successfully deleted configuration
Forbidden
Configuration not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
DELETE /api/v1/aws/configurations/{accountId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated
Was this helpful?