Api

    Rate this page:

    Api

    Performs validation checks for CP workflows

    POST /api/v1/cloud-provisioner/validate

    Request

    Body parameters
    input

    object

    additionalStates

    object

    a map of key and value

    Example

    1
2
3
4
5
6
7
8
9
10
11
12
13
    curl --request POST \
  --url 'https://admin-portfolio.prod.atl-paas.net/api/v1/cloud-provisioner/validate' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "input": {
    "entityId": "<string>",
    "atlassianAccountIdentifier": "<string>"
  },
  "additionalStates": {
    "linkedOrganization": {}
  }
}'

    Responses

    Successful operation

    Content typeValue
    application/json

    CloudProvisionerProviderResponse

    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 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, FeatureFilter]

    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

    Get A Single Workspace

    GET /api/admin/v1/workspaces/{workspaceAri}

    Request

    Path parameters
    workspaceAri Required

    string

    workspace ARI

    Example

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

    Responses

    Successful operation

    Content typeValue
    application/json

    WorkspaceModel

    Link Workspace to Org

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

    Request

    Path parameters
    orgId Required

    string

    Org ID

    workspaceAri Required

    string

    workspace ARI

    Body parameters

    Optional link request body. Both callbackUrl and audience must be provided for the callbackUrl to be successfully invoked.

    callbackUrl

    string

    Nullable: true
    audience

    string

    Nullable: true
    metadata

    object

    JSON object containing metadata map.

    Nullable: true

    Example

    1
2
3
4
5
6
7
8
    curl --request POST \
  --url 'https://admin-portfolio.prod.atl-paas.net/api/admin/v1/orgs/{orgId}/workspaces/{workspaceAri}/_link' \
  --header 'Content-Type: application/json' \
  --data '{
  "callbackUrl": "<string>",
  "audience": "<string>",
  "metadata": {}
}'

    Responses

    Successful operation

    A schema has not been defined for this response code.

    Unlink Workspace from Org

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

    Request

    Path parameters
    orgId Required

    string

    Org ID

    workspaceAri Required

    string

    workspace ARI

    Example

    1
2
    curl --request POST \
  --url 'https://admin-portfolio.prod.atl-paas.net/api/admin/v1/orgs/{orgId}/workspaces/{workspaceAri}/_unlink'

    Responses

    Successful operation

    A schema has not been defined for this response code.

    Request to create a workspace.

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

    Request

    Path parameters
    orgId Required

    string

    Organization id which workspace is linked to it.

    Body parameters

    Json data describing the workspace to be created. See typeKey for supported workspace types.

    typeKey

    string

    Nullable: false

    Valid values: bitbucket

    name

    string

    Nullable: false
    slug

    string

    Nullable: false

    Example

    1
2
3
4
5
6
7
8
9
    curl --request POST \
  --url 'https://admin-portfolio.prod.atl-paas.net/api/admin/v1/orgs/{orgId}/workspaces/_create' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "typeKey": "bitbucket",
  "name": "<string>",
  "slug": "<string>"
}'

    Responses

    Successful operation

    Content typeValue
    application/json

    CreateWorkspaceResponse

    Get Workflow Status

    GET /api/admin/v1/orgs/{orgId}/workflows/{workflowId}/status

    Request

    Path parameters
    orgId Required

    string

    Org ID

    workflowId Required

    string

    Workflow ID

    Example

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

    Responses

    Successful operation

    Content typeValue
    application/json

    WorkflowStatusResponse

    Rate this page: