API referenceConnections

List connections

GET/connections

Authorization

apiKey
AuthorizationBearer <token>

A project API key: Authorization: Bearer s0_…

In: header

Query Parameters

limit?integer
Range1 <= value <= 100
after?string
Length1 <= length <= 64
before?string
Length1 <= length <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/connections"
{  "object": "list",  "has_more": true,  "data": [    {      "object": "connection",      "id": "string",      "name": "string",      "provider": "ses",      "region": "string",      "status": "pending",      "external_id": "string",      "role_arn": "string",      "provider_account_id": "string",      "stack_version": "string",      "sandbox_status": "unknown",      "sending_quota": {        "max_24_hour_send": 0,        "max_send_rate": 0,        "sent_last_24_hours": 0,        "resets_at": "2019-08-24T14:15:22Z",        "sent_source": "cloudflare_analytics"      },      "setup_url": "http://example.com",      "last_error": "string",      "capabilities": {        "sending": true,        "receiving": true,        "receiving_in_region": true,        "dkim": "managed",        "custom_mail_from": true,        "open_tracking": true,        "click_tracking": true,        "campaigns": true,        "suppression_list": "account",        "event_delivery": "push",        "max_recipients_per_message": 1,        "max_message_bytes": 1,        "max_send_rate": 1      },      "provider_config": {        "account_id": "string",        "worker_name": "string",        "bucket_name": "string",        "queue_name": "string",        "sending_domains": [          "string"        ]      },      "data_plane": {        "version": "string",        "previous_version": "string",        "latest_version": "string",        "status": "not_deployed",        "pinned": true,        "pin": "string"      },      "credential_hint": "string",      "notices": [        {          "code": "string",          "created_at": "2019-08-24T14:15:22Z",          "detail": "string"        }      ],      "last_verified_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "stack_update": {        "current_version": "string",        "latest_version": "string",        "template_url": "string",        "stack_name": "string",        "console_url": "string",        "command": "string"      }    }  ]}