DigitalOcean API (unofficial showcase)
GET/v2/action-gateway/connections

List Connections

Returns the connections you can see, excluding revoked ones. Offset-paged with page and per_page; filter by provider, user_id, and status.

7 parameters
providerstringoptional
Optional provider slug, matched exactly.
user_idstringoptional
Optional substring of `user_id`. It must use the `user_id` alphabet, `[A-Za-z0-9._-]`.
statusstringoptional
pending|active|revoked|expired. List results always omit revoked connections, including when this filter is revoked.
Allowed:pendingactiveexpired
sortstringoptional
`created_at`, provider, `user_id`, or status. Defaults to provider, then `user_id`.
Allowed:created_atprovideruser_idstatus
sort_directionstringoptional
asc (the default) or desc.
Allowed:ascdesc
pageintegeroptional
1-based page number. Values below 1 are treated as 1.
Default:1
per_pageintegeroptional
Page size. Defaults to 20; values above 100 are capped at 100.
Default:20

6 status codes
200The request was successful.
connectionsarray<object>optional
Connections on this page.
paginationobjectoptional
Paging applied to this response and the total number of connections.
400There was an error parsing the request body.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
401Authentication failed due to invalid credentials.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429The API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500There was a server error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

Error handling

A 400 is returned: There was an error parsing the request body. A 401 is returned: Authentication failed due to invalid credentials. A 429 is returned: The API rate limit has been exceeded. A 500 is returned: There was a server error. Any other status is an error: There was an unexpected error.