GET

/workspaces

http://aps.{region}.amazonaws.com/workspaces

Lists all AMP workspaces, including workspaces being created or deleted.

Access Token Required: API Key

Query Params

aliasstring

Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.

maxResultsinteger

Maximum results to return in response (default=100, maximum=1000).

nextTokenstring

Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://aps.{region}.amazonaws.com/workspaces' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET