Api

    Rate this page:

    Api

    Get Total Count Of Workspaces

    GET /api/admin/v1/orgs/{orgId}/workspaces/totalCount

    Request

    Path parameters
    orgId Required

    string

    Org ID

    Example

    1
2
3
    curl --request GET \
  --url 'https://admin-portfolio.prod.atl-paas.net/api/admin/v1/orgs/{orgId}/workspaces/totalCount' \
  --header 'Accept: application/json'

    Responses

    Successful operation

    Content typeValue
    application/json

    WorkspaceCount

    Get Workspace Types

    GET /api/admin/v1/orgs/{orgId}/workspaces/types

    Request

    Path parameters
    orgId Required

    string

    Org ID

    Example

    1
2
3
    curl --request GET \
  --url 'https://admin-portfolio.prod.atl-paas.net/api/admin/v1/orgs/{orgId}/workspaces/types' \
  --header 'Accept: application/json'

    Responses

    Successful operation

    Content typeValue
    application/json

    WorkspaceTypeResponse

    Get Workspace Plans

    GET /api/admin/v1/orgs/{orgId}/workspaces/plans

    Request

    Path parameters
    orgId Required

    string

    Org ID

    Example

    1
2
3
    curl --request GET \
  --url 'https://admin-portfolio.prod.atl-paas.net/api/admin/v1/orgs/{orgId}/workspaces/plans' \
  --header 'Accept: application/json'

    Responses

    Successful operation

    Content typeValue
    application/json

    WorkspacePlanResponse

    Get Page of Workspaces

    POST /api/admin/v1/orgs/{orgId}/workspaces

    Request

    Path parameters
    orgId Required

    string

    Org ID

    Body parameters

    Workspace request supporting enhanced Workspace searching.

    query

    anyOf [AndOperator, FieldOperand, SearchWorkspacesOperand]

    Possible operators/operand in the event query.

    Nullable: true
    cursor

    string

    A continuation token used for pagination.

    Nullable: true
    limit

    integer

    Specifies the maximum page size.

    sort

    Array<SortField>

    Nullable: true

    Example

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
    curl --request POST \
  --url 'https://admin-portfolio.prod.atl-paas.net/api/admin/v1/orgs/{orgId}/workspaces' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": {
    "and": []
  },
  "cursor": "<string>",
  "limit": 32,
  "sort": [
    {
      "field": "<string>",
      "order": "asc"
    }
  ]
}'

    Responses

    Successful operation

    Content typeValue
    application/json

    PageDataResponse

    Get Page of Workspaces V2

    POST /api/admin/v2/orgs/{orgId}/workspaces

    Request

    Path parameters
    orgId Required

    string

    Org ID

    Body parameters

    Workspaces request supporting enhanced Workspace searching.

    query

    anyOf [AndOperator, FieldOperand, SearchWorkspacesOperand]

    Possible operators/operand in the event query.

    Nullable: true
    limit

    integer

    Specifies the maximum page size.

    Default: 20, Minimum: 1, Maximum: 1000
    sort

    Array<SortField>

    Nullable: true
    cursor

    string

    A base-64 encoded continuation token used for pagination. When a cursor is provided in the request body, no other properties may be present.

    Nullable: true

    Example

    1
2
3
4
5
6
7
    curl --request POST \
  --url 'https://admin-portfolio.prod.atl-paas.net/api/admin/v2/orgs/{orgId}/workspaces' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "cursor": "c29tZS1iYXNlLTY0LWVuY29kZWQtY3Vyc29y"
}'

    Responses

    Successful operation

    Content typeValue
    application/json

    PageDataResponseV2

    Rate this page: