IBM Cloud API Docs

Introduction

Last updated: 2020-04-13

API Connect is an integrated API management offering, with capabilities and tooling for all phases of the API lifecycle. Key steps of the API lifecycle include: create, secure, manage, socialize, and analyze.

These APIs enable you to permform actions as a member of an {{site.data.keyword.apiconnect}} provider organization; for example, create a user registry or invite a new user to join your provider organization.

For more information on using API Connect, see: Getting started.

Authentication

Most API methods require an Authorization header that includes a token with your IBM Cloud Identity and Access Management (IAM) credentials.

The header should look like this: Authorization: Bearer <token>

For more information, see Passing an IBM Cloud IAM token to authenticate with a service's API

Error handling

The APIs that you create and manage with API Connect use standard HTTP response codes to indicate whether a method completed successfully.

HTTP Error Code Description Recovery
200 Success The request was successful.
400 Bad Request The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
401 Unauthorized You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact your account owner to check your permissions.
403 Forbidden The supplied authentication is not authorized.
404 Not Found The requested resource could not be found.
408 Request Timeout The connection to the server timed out. Wait a few minutes, then try again.
409 Conflict The entity is already in the requested state.
429 Too Many Requests You have made too many requests to this endpoint and are being rate limited / throttled.
500 Internal Server Error App ID is currently unavailable. Your request could not be processed. Wait a few minutes and try again.

Methods

Create a User Registry object

Create a User Registry object

POST /orgs/{org}/user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

UserRegistry

Response

Response Body

UserRegistry

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the User Registry objects

List the User Registry objects

GET /orgs/{org}/user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

UserRegistryList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the User Registry objects

Clear the User Registry objects

DELETE /orgs/{org}/user-registries

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the User Registry object by name or id

Get the User Registry object by name or id

GET /user-registries/{org}/{user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

UserRegistry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the User Registry object by name or id

Update the User Registry object by name or id

PATCH /user-registries/{org}/{user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Request Body

UserRegistry

Response

Response Body

UserRegistry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the User Registry object by name or id

Delete the User Registry object by name or id

DELETE /user-registries/{org}/{user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Response

Response Body

UserRegistry

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Execute a User Registry operation

Execute a User Registry operation

POST /user-registries/{org}/{user-registry}/execute

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Query Parameters

  • operation
    Required*
    string

    Operation to perform on the user registry (get_base_dn_list, validate_password)

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Test a User Registry connection

Test a User Registry connection

POST /user-registries/{org}/{user-registry}/test-connection

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Request Body

TestConnectionCredentials

Response

Status Code

  • 204

    Success

  • 400

    Failure

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Execute a User Registry operation

Execute a User Registry operation

POST /orgs/{org}/user-registries/execute

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • operation
    Required*
    string

    Operation to perform on the user registry (get_base_dn_list, validate_password)

Request Body

UserRegistryExecute

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Test a User Registry connection

Test a User Registry connection

POST /orgs/{org}/user-registries/test-connection

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

UserRegistryTestConnection

Response

Status Code

  • 204

    Success

  • 400

    Failure

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Search for users in the user registry

Search for users in the user registry

POST /user-registries/{org}/{user-registry}/search

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Query Parameters

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Request Body

UserSearch

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a User object

Create a User object

POST /user-registries/{org}/{user-registry}/users

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Request Body

User

Response

Response Body

User

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the User objects

List the User objects

GET /user-registries/{org}/{user-registry}/users

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the User objects

Clear the User objects

DELETE /user-registries/{org}/{user-registry}/users

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the User object by name or id

Get the User object by name or id

GET /user-registries/{org}/{user-registry}/users/{user}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

  • user
    Required*
    string

    User name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

User

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the User object by name or id

Update the User object by name or id

PATCH /user-registries/{org}/{user-registry}/users/{user}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

  • user
    Required*
    string

    User name or id

Request Body

User

Response

Response Body

User

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the User object by name or id

Delete the User object by name or id

DELETE /user-registries/{org}/{user-registry}/users/{user}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

  • user
    Required*
    string

    User name or id

Response

Response Body

User

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Send reset password link

Send reset password link

POST /request-password-reset

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

RequestPasswordReset

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset password

Reset password

POST /user-registries/{org}/{user-registry}/users/{user}/reset-password

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

  • user
    Required*
    string

    User name or id

Request Body

ResetPassword

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Search for users in the admin realm

Search for users in the admin realm

POST /cloud/admin/search/user

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Request Body

UserSearch

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Search for users in the provider realm

Search for users in the provider realm

POST /cloud/provider/search/user

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Request Body

UserSearch

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List Identity Providers in the admin realm

List Identity Providers in the admin realm

GET /cloud/admin/identity-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

IdentityProviderList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List Identity Providers in the provider realm

List Identity Providers in the provider realm

GET /cloud/provider/identity-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

IdentityProviderList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Generate a token

Generate a token

POST /token

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

TokenRequest

Response

Response Body

TokenResponse

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

APIC authorization endpoint

APIC authorize endpoint

GET /oauth2/authorize

Request

Query Parameters

  • realm
    Required*
    string

    User registry realm name

  • response_type
    Required*
    string

    Oauth2 response_type

  • client_id
    string

    Registration client identifier

  • state
    string

    State for a webhook event in subscriber queue

  • redirect_uri
    string

    Redirect Url

  • token
    string

    token

  • name
    string

    token

  • title
    string

    token

  • summary
    string

    token

  • invitation_scope
    string

    token

Response

Status Code

  • 302

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a API Key object

Create a API Key object

POST /cloud/api-keys

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

APIKey

Response

Response Body

APIKey

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the API Key objects

List the API Key objects

GET /cloud/api-keys

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIKeyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API Key object by name or id

Get the API Key object by name or id

GET /cloud/api-keys/{api-key}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-key
    Required*
    string

    API Key name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

APIKey

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the API Key object by name or id

Delete the API Key object by name or id

DELETE /cloud/api-keys/{api-key}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-key
    Required*
    string

    API Key name or id

Response

Response Body

APIKey

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Search for users in the catalog user registry

Search for users in the catalog user registry

POST /catalogs/{org}/{catalog}/configured-catalog-user-registries/{configured-catalog-user-registry}/search

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-catalog-user-registry
    Required*
    string

    Configured Catalog User Registry name or id

Query Parameters

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Request Body

UserSearch

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Search for users in the catalog realm

Search for users in the catalog realm

POST /catalogs/{org}/{catalog}/search/user

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Request Body

UserSearch

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a User Registry object

Create a User Registry object

POST /orgs/{org}/user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

UserRegistry

Response

Response Body

UserRegistry

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the User Registry objects

List the User Registry objects

GET /orgs/{org}/user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

UserRegistryList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the User Registry objects

Clear the User Registry objects

DELETE /orgs/{org}/user-registries

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the User Registry object by name or id

Get the User Registry object by name or id

GET /user-registries/{org}/{user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

UserRegistry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the User Registry object by name or id

Update the User Registry object by name or id

PATCH /user-registries/{org}/{user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Request Body

UserRegistry

Response

Response Body

UserRegistry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the User Registry object by name or id

Delete the User Registry object by name or id

DELETE /user-registries/{org}/{user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Response

Response Body

UserRegistry

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Execute a User Registry operation

Execute a User Registry operation

POST /user-registries/{org}/{user-registry}/execute

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Query Parameters

  • operation
    Required*
    string

    Operation to perform on the user registry (get_base_dn_list, validate_password)

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Test a User Registry connection

Test a User Registry connection

POST /user-registries/{org}/{user-registry}/test-connection

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Request Body

TestConnectionCredentials

Response

Status Code

  • 204

    Success

  • 400

    Failure

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Execute a User Registry operation

Execute a User Registry operation

POST /orgs/{org}/user-registries/execute

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • operation
    Required*
    string

    Operation to perform on the user registry (get_base_dn_list, validate_password)

Request Body

UserRegistryExecute

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Test a User Registry connection

Test a User Registry connection

POST /orgs/{org}/user-registries/test-connection

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

UserRegistryTestConnection

Response

Status Code

  • 204

    Success

  • 400

    Failure

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Search for users in the user registry

Search for users in the user registry

POST /user-registries/{org}/{user-registry}/search

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Query Parameters

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Request Body

UserSearch

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List Identity Providers in the admin realm

List Identity Providers in the admin realm

GET /cloud/admin/identity-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

IdentityProviderList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List Identity Providers in the provider realm

List Identity Providers in the provider realm

GET /cloud/provider/identity-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

IdentityProviderList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Search for users in the catalog user registry

Search for users in the catalog user registry

POST /catalogs/{org}/{catalog}/configured-catalog-user-registries/{configured-catalog-user-registry}/search

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-catalog-user-registry
    Required*
    string

    Configured Catalog User Registry name or id

Query Parameters

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Request Body

UserSearch

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a User object

Create a User object

POST /user-registries/{org}/{user-registry}/users

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Request Body

User

Response

Response Body

User

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the User objects

List the User objects

GET /user-registries/{org}/{user-registry}/users

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the User objects

Clear the User objects

DELETE /user-registries/{org}/{user-registry}/users

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the User object by name or id

Get the User object by name or id

GET /user-registries/{org}/{user-registry}/users/{user}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

  • user
    Required*
    string

    User name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

User

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the User object by name or id

Update the User object by name or id

PATCH /user-registries/{org}/{user-registry}/users/{user}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

  • user
    Required*
    string

    User name or id

Request Body

User

Response

Response Body

User

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the User object by name or id

Delete the User object by name or id

DELETE /user-registries/{org}/{user-registry}/users/{user}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

  • user
    Required*
    string

    User name or id

Response

Response Body

User

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Send reset password link

Send reset password link

POST /request-password-reset

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

RequestPasswordReset

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset password

Reset password

POST /user-registries/{org}/{user-registry}/users/{user}/reset-password

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • user-registry
    Required*
    string

    User Registry name or id

  • user
    Required*
    string

    User name or id

Request Body

ResetPassword

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Search for users in the admin realm

Search for users in the admin realm

POST /cloud/admin/search/user

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Request Body

UserSearch

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Search for users in the provider realm

Search for users in the provider realm

POST /cloud/provider/search/user

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Request Body

UserSearch

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Search for users in the catalog realm

Search for users in the catalog realm

POST /catalogs/{org}/{catalog}/search/user

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Request Body

UserSearch

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Generate a token

Generate a token

POST /token

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

TokenRequest

Response

Response Body

TokenResponse

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Authorization provider redirect endpoint

Authorization provider redirect endpoint

GET /oauth2/redirect

Request

Query Parameters

  • state
    string

    State for a webhook event in subscriber queue

  • code
    string

    Oauth2 code

  • error
    string

    error per OAuth specification

  • error_description
    string

    error_description per OAuth specification

  • error_uri
    string

    error_uri per OAuth specification

  • oauth_token
    string

    Oauth Token for Twitter

  • oauth_verifier
    string

    Oauth Verifier for Twitter

Response

Status Code

  • 302

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Authorization provider redirect endpoint

Authorization provider redirect endpoint

POST /oauth2/redirect

Request

Query Parameters

  • state
    string

    State for a webhook event in subscriber queue

  • code
    string

    Oauth2 code

  • error
    string

    error per OAuth specification

  • error_description
    string

    error_description per OAuth specification

  • error_uri
    string

    error_uri per OAuth specification

  • oauth_token
    string

    Oauth Token for Twitter

  • oauth_verifier
    string

    Oauth Verifier for Twitter

Form Parameters

  • code
    string
  • state
    string
  • error
    string
  • error_description
    string
  • error_uri
    string

Response

Status Code

  • 302

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Authorization provider redirect endpoint

Authorization provider redirect endpoint

GET /oauth2/redirect

Request

Query Parameters

  • state
    string

    State for a webhook event in subscriber queue

  • code
    string

    Oauth2 code

  • error
    string

    error per OAuth specification

  • error_description
    string

    error_description per OAuth specification

  • error_uri
    string

    error_uri per OAuth specification

  • oauth_token
    string

    Oauth Token for Twitter

  • oauth_verifier
    string

    Oauth Verifier for Twitter

Response

Status Code

  • 302

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Authorization provider redirect endpoint

Authorization provider redirect endpoint

POST /oauth2/redirect

Request

Query Parameters

  • state
    string

    State for a webhook event in subscriber queue

  • code
    string

    Oauth2 code

  • error
    string

    error per OAuth specification

  • error_description
    string

    error_description per OAuth specification

  • error_uri
    string

    error_uri per OAuth specification

  • oauth_token
    string

    Oauth Token for Twitter

  • oauth_verifier
    string

    Oauth Verifier for Twitter

Form Parameters

  • code
    string
  • state
    string
  • error
    string
  • error_description
    string
  • error_uri
    string

Response

Status Code

  • 302

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

APIC authorization endpoint

APIC authorize endpoint

GET /oauth2/authorize

Request

Query Parameters

  • realm
    Required*
    string

    User registry realm name

  • response_type
    Required*
    string

    Oauth2 response_type

  • client_id
    string

    Registration client identifier

  • state
    string

    State for a webhook event in subscriber queue

  • redirect_uri
    string

    Redirect Url

  • token
    string

    token

  • name
    string

    token

  • title
    string

    token

  • summary
    string

    token

  • invitation_scope
    string

    token

Response

Status Code

  • 302

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a API Key object

Create a API Key object

POST /cloud/api-keys

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

APIKey

Response

Response Body

APIKey

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the API Key objects

List the API Key objects

GET /cloud/api-keys

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIKeyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API Key object by name or id

Get the API Key object by name or id

GET /cloud/api-keys/{api-key}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-key
    Required*
    string

    API Key name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

APIKey

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the API Key object by name or id

Delete the API Key object by name or id

DELETE /cloud/api-keys/{api-key}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-key
    Required*
    string

    API Key name or id

Response

Response Body

APIKey

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Organization Setting object

Get the Organization Setting object

GET /orgs/{org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

OrgSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Organization Setting object

Update the Organization Setting object

PUT /orgs/{org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

OrgSetting

Response

Response Body

OrgSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Notification Template objects in all collections

List all Notification Template objects in all collections

GET /orgs/{org}/settings/notification-templates

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /orgs/{org}/settings/notification-templates/provider

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /orgs/{org}/settings/notification-templates/provider/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /orgs/{org}/settings/notification-templates/provider/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /orgs/{org}/settings/notification-templates/catalog

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /orgs/{org}/settings/notification-templates/catalog/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /orgs/{org}/settings/notification-templates/catalog/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /orgs/{org}/settings/notification-templates/space

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /orgs/{org}/settings/notification-templates/space/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /orgs/{org}/settings/notification-templates/space/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /orgs/{org}/settings/notification-templates/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /orgs/{org}/settings/notification-templates/consumer/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /orgs/{org}/settings/notification-templates/consumer/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Organization Setting object

Get the Organization Setting object

GET /orgs/{org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

OrgSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Organization Setting object

Update the Organization Setting object

PUT /orgs/{org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

OrgSetting

Response

Response Body

OrgSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Notification Template objects in all collections

List all Notification Template objects in all collections

GET /orgs/{org}/settings/notification-templates

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /orgs/{org}/settings/notification-templates/provider

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /orgs/{org}/settings/notification-templates/provider/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /orgs/{org}/settings/notification-templates/provider/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /orgs/{org}/settings/notification-templates/catalog

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /orgs/{org}/settings/notification-templates/catalog/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /orgs/{org}/settings/notification-templates/catalog/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /orgs/{org}/settings/notification-templates/space

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /orgs/{org}/settings/notification-templates/space/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /orgs/{org}/settings/notification-templates/space/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /orgs/{org}/settings/notification-templates/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /orgs/{org}/settings/notification-templates/consumer/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /orgs/{org}/settings/notification-templates/consumer/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Organization object by name or id

Get the Organization object by name or id

GET /orgs/{org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Org

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Organization object by name or id

Update the Organization object by name or id

PATCH /orgs/{org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Org

Response

Response Body

Org

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Organization object by name or id

Delete the Organization object by name or id

DELETE /orgs/{org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Response

Response Body

Org

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Transfer owner to an associate

Transfer owner to an associate

POST /orgs/{org}/transfer-owner

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

TransferOwner

Response

Response Body

Org

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Search provider users from an organization.

Search provider users from an organization.

POST /orgs/{org}/search/user

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Request Body

UserSearch

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Associate objects

List the Associate objects

GET /orgs/{org}/associates

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AssociateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Associate object by name or id

Get the Associate object by name or id

GET /orgs/{org}/associates/{associate}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • associate
    Required*
    string

    Associate name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Associate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member Invitation object

Create a Member Invitation object

POST /orgs/{org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member Invitation objects

List the Member Invitation objects

GET /orgs/{org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberInvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member Invitation objects

Clear the Member Invitation objects

DELETE /orgs/{org}/member-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member Invitation object by name or id

Get the Member Invitation object by name or id

GET /orgs/{org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member Invitation object by name or id

Update the Member Invitation object by name or id

PATCH /orgs/{org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member Invitation object by name or id

Delete the Member Invitation object by name or id

DELETE /orgs/{org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Response

Response Body

MemberInvitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Member Invitation

Regenerate the Member Invitation

POST /orgs/{org}/member-invitations/{member-invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

Regenerate

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Register using the Member Invitation

Register using the Member Invitation

POST /orgs/{org}/member-invitations/{member-invitation}/register

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationRegister

Response

Response Body

MemberRegisterResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Accept using the Member Invitation

Accept using the Member Invitation

POST /orgs/{org}/member-invitations/{member-invitation}/accept

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationAccept

Response

Response Body

MemberAcceptResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member object

Create a Member object

POST /orgs/{org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member objects

List the Member objects

GET /orgs/{org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member objects

Clear the Member objects

DELETE /orgs/{org}/members

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member object by name or id

Get the Member object by name or id

GET /orgs/{org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member
    Required*
    string

    Member name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member object by name or id

Update the Member object by name or id

PATCH /orgs/{org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member
    Required*
    string

    Member name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member object by name or id

Delete the Member object by name or id

DELETE /orgs/{org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member
    Required*
    string

    Member name or id

Response

Response Body

Member

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Permission objects in all collections

List all Permission objects in all collections

GET /cloud/permissions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Permission objects

List the Permission objects

GET /cloud/permissions/org

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Permission object by name or id

Get the Permission object by name or id

GET /cloud/permissions/org/{permission}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • permission
    Required*
    string

    Permission name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Permission

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Permission objects

List the Permission objects

GET /cloud/permissions/cloud

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Permission object by name or id

Get the Permission object by name or id

GET /cloud/permissions/cloud/{permission}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • permission
    Required*
    string

    Permission name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Permission

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Permission objects

List the Permission objects

GET /cloud/permissions/provider

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Permission object by name or id

Get the Permission object by name or id

GET /cloud/permissions/provider/{permission}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • permission
    Required*
    string

    Permission name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Permission

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Permission objects

List the Permission objects

GET /cloud/permissions/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Permission object by name or id

Get the Permission object by name or id

GET /cloud/permissions/consumer/{permission}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • permission
    Required*
    string

    Permission name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Permission

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Permission objects

List the Permission objects

GET /cloud/permissions/deployment

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Permission object by name or id

Get the Permission object by name or id

GET /cloud/permissions/deployment/{permission}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • permission
    Required*
    string

    Permission name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Permission

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Role object

Create a Role object

POST /orgs/{org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role objects

List the Role objects

GET /orgs/{org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Role objects

Clear the Role objects

DELETE /orgs/{org}/roles

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role object by name or id

Get the Role object by name or id

GET /orgs/{org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • role
    Required*
    string

    Role name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role object by name or id

Update the Role object by name or id

PATCH /orgs/{org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • role
    Required*
    string

    Role name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Role object by name or id

Delete the Role object by name or id

DELETE /orgs/{org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • role
    Required*
    string

    Role name or id

Response

Response Body

Role

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Activation objects

List the Activation objects

GET /catalogs/{org}/{catalog}/activations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ActivationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Activation objects

Clear the Activation objects

DELETE /catalogs/{org}/{catalog}/activations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Activation object by name or id

Get the Activation object by name or id

GET /activations/{org}/{catalog}/{activation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • activation
    Required*
    string

    Activation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Activation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Activation object by name or id

Delete the Activation object by name or id

DELETE /activations/{org}/{catalog}/{activation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • activation
    Required*
    string

    Activation name or id

Response

Response Body

Activation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Organization object by name or id

Get the Organization object by name or id

GET /orgs/{org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Org

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Organization object by name or id

Update the Organization object by name or id

PATCH /orgs/{org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Org

Response

Response Body

Org

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Organization object by name or id

Delete the Organization object by name or id

DELETE /orgs/{org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Response

Response Body

Org

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Transfer owner to an associate

Transfer owner to an associate

POST /orgs/{org}/transfer-owner

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

TransferOwner

Response

Response Body

Org

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Search provider users from an organization.

Search provider users from an organization.

POST /orgs/{org}/search/user

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Request Body

UserSearch

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Associate objects

List the Associate objects

GET /orgs/{org}/associates

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AssociateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Associate object by name or id

Get the Associate object by name or id

GET /orgs/{org}/associates/{associate}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • associate
    Required*
    string

    Associate name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Associate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member Invitation object

Create a Member Invitation object

POST /orgs/{org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member Invitation objects

List the Member Invitation objects

GET /orgs/{org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberInvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member Invitation objects

Clear the Member Invitation objects

DELETE /orgs/{org}/member-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member Invitation object by name or id

Get the Member Invitation object by name or id

GET /orgs/{org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member Invitation object by name or id

Update the Member Invitation object by name or id

PATCH /orgs/{org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member Invitation object by name or id

Delete the Member Invitation object by name or id

DELETE /orgs/{org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Response

Response Body

MemberInvitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Member Invitation

Regenerate the Member Invitation

POST /orgs/{org}/member-invitations/{member-invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

Regenerate

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Register using the Member Invitation

Register using the Member Invitation

POST /orgs/{org}/member-invitations/{member-invitation}/register

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationRegister

Response

Response Body

MemberRegisterResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Accept using the Member Invitation

Accept using the Member Invitation

POST /orgs/{org}/member-invitations/{member-invitation}/accept

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationAccept

Response

Response Body

MemberAcceptResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member object

Create a Member object

POST /orgs/{org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member objects

List the Member objects

GET /orgs/{org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member objects

Clear the Member objects

DELETE /orgs/{org}/members

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member object by name or id

Get the Member object by name or id

GET /orgs/{org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member
    Required*
    string

    Member name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member object by name or id

Update the Member object by name or id

PATCH /orgs/{org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member
    Required*
    string

    Member name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member object by name or id

Delete the Member object by name or id

DELETE /orgs/{org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member
    Required*
    string

    Member name or id

Response

Response Body

Member

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Permission objects in all collections

List all Permission objects in all collections

GET /cloud/permissions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Permission objects

List the Permission objects

GET /cloud/permissions/org

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Permission object by name or id

Get the Permission object by name or id

GET /cloud/permissions/org/{permission}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • permission
    Required*
    string

    Permission name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Permission

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Permission objects

List the Permission objects

GET /cloud/permissions/cloud

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Permission object by name or id

Get the Permission object by name or id

GET /cloud/permissions/cloud/{permission}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • permission
    Required*
    string

    Permission name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Permission

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Permission objects

List the Permission objects

GET /cloud/permissions/provider

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Permission object by name or id

Get the Permission object by name or id

GET /cloud/permissions/provider/{permission}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • permission
    Required*
    string

    Permission name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Permission

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Permission objects

List the Permission objects

GET /cloud/permissions/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Permission object by name or id

Get the Permission object by name or id

GET /cloud/permissions/consumer/{permission}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • permission
    Required*
    string

    Permission name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Permission

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Permission objects

List the Permission objects

GET /cloud/permissions/deployment

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Permission object by name or id

Get the Permission object by name or id

GET /cloud/permissions/deployment/{permission}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • permission
    Required*
    string

    Permission name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Permission

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Role object

Create a Role object

POST /orgs/{org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role objects

List the Role objects

GET /orgs/{org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Role objects

Clear the Role objects

DELETE /orgs/{org}/roles

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role object by name or id

Get the Role object by name or id

GET /orgs/{org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • role
    Required*
    string

    Role name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role object by name or id

Update the Role object by name or id

PATCH /orgs/{org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • role
    Required*
    string

    Role name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Role object by name or id

Delete the Role object by name or id

DELETE /orgs/{org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • role
    Required*
    string

    Role name or id

Response

Response Body

Role

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Gateway Service objects

List the Gateway Service objects

GET /orgs/{org}/gateway-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

GatewayServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Gateway Service object by name or id

Get the Gateway Service object by name or id

GET /orgs/{org}/gateway-services/{gateway-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • gateway-service
    Required*
    string

    Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GatewayService

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Portal Service objects

List the Portal Service objects

GET /orgs/{org}/portal-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PortalServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Portal Service object by name or id

Get the Portal Service object by name or id

GET /orgs/{org}/portal-services/{portal-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • portal-service
    Required*
    string

    Portal Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

PortalService

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Oauth Provider object

Create a Oauth Provider object

POST /orgs/{org}/oauth-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

OauthProvider

Response

Response Body

OauthProvider

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Oauth Provider objects

List the Oauth Provider objects

GET /orgs/{org}/oauth-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

OauthProviderList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Oauth Provider objects

Clear the Oauth Provider objects

DELETE /orgs/{org}/oauth-providers

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Oauth Provider object by name or id

Get the Oauth Provider object by name or id

GET /orgs/{org}/oauth-providers/{oauth-provider}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • oauth-provider
    Required*
    string

    Oauth Provider name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

OauthProvider

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Oauth Provider object by name or id

Update the Oauth Provider object by name or id

PATCH /orgs/{org}/oauth-providers/{oauth-provider}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • oauth-provider
    Required*
    string

    Oauth Provider name or id

Request Body

OauthProvider

Response

Response Body

OauthProvider

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Oauth Provider object by name or id

Delete the Oauth Provider object by name or id

DELETE /orgs/{org}/oauth-providers/{oauth-provider}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • oauth-provider
    Required*
    string

    Oauth Provider name or id

Response

Response Body

OauthProvider

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Billing object

Create a Billing object

POST /orgs/{org}/billings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Billing

Response

Response Body

Billing

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Billing objects

List the Billing objects

GET /orgs/{org}/billings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

BillingList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Billing objects

Clear the Billing objects

DELETE /orgs/{org}/billings

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Billing object by name or id

Get the Billing object by name or id

GET /orgs/{org}/billings/{billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Billing

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Billing object by name or id

Update the Billing object by name or id

PATCH /orgs/{org}/billings/{billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

Request Body

Billing

Response

Response Body

Billing

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Billing object by name or id

Delete the Billing object by name or id

DELETE /orgs/{org}/billings/{billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

Response

Response Body

Billing

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Job objects

List the Job objects

GET /orgs/{org}/billings/{billing}/jobs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

JobList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Job objects

Clear the Job objects

DELETE /orgs/{org}/billings/{billing}/jobs

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Job object by name or id

Get the Job object by name or id

GET /orgs/{org}/billings/{billing}/jobs/{job}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

  • job
    Required*
    string

    Job name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Job

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Job object by name or id

Delete the Job object by name or id

DELETE /orgs/{org}/billings/{billing}/jobs/{job}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

  • job
    Required*
    string

    Job name or id

Response

Response Body

Job

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Re-attempt blocked or failed job

Re-attempt blocked or failed job

POST /orgs/{org}/billings/{billing}/jobs/{job}/retry

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

  • job
    Required*
    string

    Job name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a TLS Client Profile object

Create a TLS Client Profile object

POST /orgs/{org}/tls-client-profiles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

TLSClientProfile

Response

Response Body

TLSClientProfile

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all TLS Client Profile objects in all collections

List all TLS Client Profile objects in all collections

GET /orgs/{org}/tls-client-profiles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

TLSClientProfileList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all TLS Client Profile objects in all collections

Clear all TLS Client Profile objects in all collections

DELETE /orgs/{org}/tls-client-profiles

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

  • cascade
    boolean

    Cascade the behavior

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the TLS Client Profile objects

List the TLS Client Profile objects

GET /orgs/{org}/tls-client-profiles/{tls-client-profile-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-name
    Required*
    string

    TLS Client Profile name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

TLSClientProfileList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the TLS Client Profile objects

Clear the TLS Client Profile objects

DELETE /orgs/{org}/tls-client-profiles/{tls-client-profile-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-name
    Required*
    string

    TLS Client Profile name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the TLS Client Profile object by id

Get the TLS Client Profile object by id

GET /orgs/{org}/tls-client-profiles/{tls-client-profile-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-id
    Required*
    string

    TLS Client Profile name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

TLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the TLS Client Profile object by id

Update the TLS Client Profile object by id

PATCH /orgs/{org}/tls-client-profiles/{tls-client-profile-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-id
    Required*
    string

    TLS Client Profile name

Request Body

TLSClientProfile

Response

Response Body

TLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the TLS Client Profile object by id

Delete the TLS Client Profile object by id

DELETE /orgs/{org}/tls-client-profiles/{tls-client-profile-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-id
    Required*
    string

    TLS Client Profile name

Response

Response Body

TLSClientProfile

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the TLS Client Profile object by name and version

Get the TLS Client Profile object by name and version

GET /orgs/{org}/tls-client-profiles/{tls-client-profile-name}/{tls-client-profile-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-name
    Required*
    string

    TLS Client Profile name

  • tls-client-profile-version
    Required*
    string

    TLS Client Profile version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

TLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the TLS Client Profile object by name and version

Update the TLS Client Profile object by name and version

PATCH /orgs/{org}/tls-client-profiles/{tls-client-profile-name}/{tls-client-profile-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-name
    Required*
    string

    TLS Client Profile name

  • tls-client-profile-version
    Required*
    string

    TLS Client Profile version name

Request Body

TLSClientProfile

Response

Response Body

TLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a TLS Client Profile

Delete a TLS Client Profile

DELETE /orgs/{org}/tls-client-profiles/{tls-client-profile-name}/{tls-client-profile-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-name
    Required*
    string

    TLS Client Profile name

  • tls-client-profile-version
    Required*
    string

    TLS Client Profile version name

Response

Response Body

TLSClientProfile

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Keystore object

Create a Keystore object

POST /orgs/{org}/keystores

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Keystore

Response

Response Body

Keystore

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Keystore objects

List the Keystore objects

GET /orgs/{org}/keystores

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

KeystoreList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Keystore objects

Clear the Keystore objects

DELETE /orgs/{org}/keystores

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Keystore object by name or id

Get the Keystore object by name or id

GET /orgs/{org}/keystores/{keystore}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • keystore
    Required*
    string

    Keystore name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Keystore

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Keystore object by name or id

Update the Keystore object by name or id

PATCH /orgs/{org}/keystores/{keystore}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • keystore
    Required*
    string

    Keystore name or id

Request Body

Keystore

Response

Response Body

Keystore

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Keystore object by name or id

Delete the Keystore object by name or id

DELETE /orgs/{org}/keystores/{keystore}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • keystore
    Required*
    string

    Keystore name or id

Response

Response Body

Keystore

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Truststore object

Create a Truststore object

POST /orgs/{org}/truststores

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Truststore

Response

Response Body

Truststore

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Truststore objects

List the Truststore objects

GET /orgs/{org}/truststores

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

TruststoreList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Truststore objects

Clear the Truststore objects

DELETE /orgs/{org}/truststores

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Truststore object by name or id

Get the Truststore object by name or id

GET /orgs/{org}/truststores/{truststore}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Truststore

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Truststore object by name or id

Update the Truststore object by name or id

PATCH /orgs/{org}/truststores/{truststore}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

Request Body

Truststore

Response

Response Body

Truststore

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Truststore object by name or id

Delete the Truststore object by name or id

DELETE /orgs/{org}/truststores/{truststore}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

Response

Response Body

Truststore

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Entry object

Create a Entry object

POST /orgs/{org}/truststores/{truststore}/entries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

Request Body

Entry

Response

Response Body

Entry

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Entry objects

List the Entry objects

GET /orgs/{org}/truststores/{truststore}/entries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

EntryList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Entry objects

Clear the Entry objects

DELETE /orgs/{org}/truststores/{truststore}/entries

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Entry object by name or id

Get the Entry object by name or id

GET /orgs/{org}/truststores/{truststore}/entries/{entry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

  • entry
    Required*
    string

    Entry name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Entry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Entry object by name or id

Update the Entry object by name or id

PATCH /orgs/{org}/truststores/{truststore}/entries/{entry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

  • entry
    Required*
    string

    Entry name or id

Request Body

Entry

Response

Response Body

Entry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Entry object by name or id

Delete the Entry object by name or id

DELETE /orgs/{org}/truststores/{truststore}/entries/{entry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

  • entry
    Required*
    string

    Entry name or id

Response

Response Body

Entry

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Gateway Service objects

List the Gateway Service objects

GET /orgs/{org}/gateway-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

GatewayServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Gateway Service object by name or id

Get the Gateway Service object by name or id

GET /orgs/{org}/gateway-services/{gateway-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • gateway-service
    Required*
    string

    Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GatewayService

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Portal Service objects

List the Portal Service objects

GET /orgs/{org}/portal-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PortalServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Portal Service object by name or id

Get the Portal Service object by name or id

GET /orgs/{org}/portal-services/{portal-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • portal-service
    Required*
    string

    Portal Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

PortalService

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Oauth Provider object

Create a Oauth Provider object

POST /orgs/{org}/oauth-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

OauthProvider

Response

Response Body

OauthProvider

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Oauth Provider objects

List the Oauth Provider objects

GET /orgs/{org}/oauth-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

OauthProviderList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Oauth Provider objects

Clear the Oauth Provider objects

DELETE /orgs/{org}/oauth-providers

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Oauth Provider object by name or id

Get the Oauth Provider object by name or id

GET /orgs/{org}/oauth-providers/{oauth-provider}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • oauth-provider
    Required*
    string

    Oauth Provider name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

OauthProvider

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Oauth Provider object by name or id

Update the Oauth Provider object by name or id

PATCH /orgs/{org}/oauth-providers/{oauth-provider}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • oauth-provider
    Required*
    string

    Oauth Provider name or id

Request Body

OauthProvider

Response

Response Body

OauthProvider

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Oauth Provider object by name or id

Delete the Oauth Provider object by name or id

DELETE /orgs/{org}/oauth-providers/{oauth-provider}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • oauth-provider
    Required*
    string

    Oauth Provider name or id

Response

Response Body

OauthProvider

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Billing object

Create a Billing object

POST /orgs/{org}/billings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Billing

Response

Response Body

Billing

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Billing objects

List the Billing objects

GET /orgs/{org}/billings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

BillingList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Billing objects

Clear the Billing objects

DELETE /orgs/{org}/billings

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Billing object by name or id

Get the Billing object by name or id

GET /orgs/{org}/billings/{billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Billing

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Billing object by name or id

Update the Billing object by name or id

PATCH /orgs/{org}/billings/{billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

Request Body

Billing

Response

Response Body

Billing

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Billing object by name or id

Delete the Billing object by name or id

DELETE /orgs/{org}/billings/{billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

Response

Response Body

Billing

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Job objects

List the Job objects

GET /orgs/{org}/billings/{billing}/jobs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

JobList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Job objects

Clear the Job objects

DELETE /orgs/{org}/billings/{billing}/jobs

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Job object by name or id

Get the Job object by name or id

GET /orgs/{org}/billings/{billing}/jobs/{job}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

  • job
    Required*
    string

    Job name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Job

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Job object by name or id

Delete the Job object by name or id

DELETE /orgs/{org}/billings/{billing}/jobs/{job}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

  • job
    Required*
    string

    Job name or id

Response

Response Body

Job

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Re-attempt blocked or failed job

Re-attempt blocked or failed job

POST /orgs/{org}/billings/{billing}/jobs/{job}/retry

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

  • job
    Required*
    string

    Job name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a TLS Client Profile object

Create a TLS Client Profile object

POST /orgs/{org}/tls-client-profiles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

TLSClientProfile

Response

Response Body

TLSClientProfile

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all TLS Client Profile objects in all collections

List all TLS Client Profile objects in all collections

GET /orgs/{org}/tls-client-profiles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

TLSClientProfileList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all TLS Client Profile objects in all collections

Clear all TLS Client Profile objects in all collections

DELETE /orgs/{org}/tls-client-profiles

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

  • cascade
    boolean

    Cascade the behavior

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the TLS Client Profile objects

List the TLS Client Profile objects

GET /orgs/{org}/tls-client-profiles/{tls-client-profile-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-name
    Required*
    string

    TLS Client Profile name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

TLSClientProfileList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the TLS Client Profile objects

Clear the TLS Client Profile objects

DELETE /orgs/{org}/tls-client-profiles/{tls-client-profile-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-name
    Required*
    string

    TLS Client Profile name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the TLS Client Profile object by id

Get the TLS Client Profile object by id

GET /orgs/{org}/tls-client-profiles/{tls-client-profile-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-id
    Required*
    string

    TLS Client Profile name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

TLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the TLS Client Profile object by id

Update the TLS Client Profile object by id

PATCH /orgs/{org}/tls-client-profiles/{tls-client-profile-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-id
    Required*
    string

    TLS Client Profile name

Request Body

TLSClientProfile

Response

Response Body

TLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the TLS Client Profile object by id

Delete the TLS Client Profile object by id

DELETE /orgs/{org}/tls-client-profiles/{tls-client-profile-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-id
    Required*
    string

    TLS Client Profile name

Response

Response Body

TLSClientProfile

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the TLS Client Profile object by name and version

Get the TLS Client Profile object by name and version

GET /orgs/{org}/tls-client-profiles/{tls-client-profile-name}/{tls-client-profile-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-name
    Required*
    string

    TLS Client Profile name

  • tls-client-profile-version
    Required*
    string

    TLS Client Profile version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

TLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the TLS Client Profile object by name and version

Update the TLS Client Profile object by name and version

PATCH /orgs/{org}/tls-client-profiles/{tls-client-profile-name}/{tls-client-profile-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-name
    Required*
    string

    TLS Client Profile name

  • tls-client-profile-version
    Required*
    string

    TLS Client Profile version name

Request Body

TLSClientProfile

Response

Response Body

TLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a TLS Client Profile

Delete a TLS Client Profile

DELETE /orgs/{org}/tls-client-profiles/{tls-client-profile-name}/{tls-client-profile-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • tls-client-profile-name
    Required*
    string

    TLS Client Profile name

  • tls-client-profile-version
    Required*
    string

    TLS Client Profile version name

Response

Response Body

TLSClientProfile

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Keystore object

Create a Keystore object

POST /orgs/{org}/keystores

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Keystore

Response

Response Body

Keystore

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Keystore objects

List the Keystore objects

GET /orgs/{org}/keystores

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

KeystoreList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Keystore objects

Clear the Keystore objects

DELETE /orgs/{org}/keystores

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Keystore object by name or id

Get the Keystore object by name or id

GET /orgs/{org}/keystores/{keystore}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • keystore
    Required*
    string

    Keystore name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Keystore

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Keystore object by name or id

Update the Keystore object by name or id

PATCH /orgs/{org}/keystores/{keystore}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • keystore
    Required*
    string

    Keystore name or id

Request Body

Keystore

Response

Response Body

Keystore

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Keystore object by name or id

Delete the Keystore object by name or id

DELETE /orgs/{org}/keystores/{keystore}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • keystore
    Required*
    string

    Keystore name or id

Response

Response Body

Keystore

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Truststore object

Create a Truststore object

POST /orgs/{org}/truststores

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Truststore

Response

Response Body

Truststore

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Truststore objects

List the Truststore objects

GET /orgs/{org}/truststores

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

TruststoreList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Truststore objects

Clear the Truststore objects

DELETE /orgs/{org}/truststores

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Truststore object by name or id

Get the Truststore object by name or id

GET /orgs/{org}/truststores/{truststore}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Truststore

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Truststore object by name or id

Update the Truststore object by name or id

PATCH /orgs/{org}/truststores/{truststore}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

Request Body

Truststore

Response

Response Body

Truststore

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Truststore object by name or id

Delete the Truststore object by name or id

DELETE /orgs/{org}/truststores/{truststore}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

Response

Response Body

Truststore

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Entry object

Create a Entry object

POST /orgs/{org}/truststores/{truststore}/entries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

Request Body

Entry

Response

Response Body

Entry

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Entry objects

List the Entry objects

GET /orgs/{org}/truststores/{truststore}/entries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

EntryList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Entry objects

Clear the Entry objects

DELETE /orgs/{org}/truststores/{truststore}/entries

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Entry object by name or id

Get the Entry object by name or id

GET /orgs/{org}/truststores/{truststore}/entries/{entry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

  • entry
    Required*
    string

    Entry name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Entry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Entry object by name or id

Update the Entry object by name or id

PATCH /orgs/{org}/truststores/{truststore}/entries/{entry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

  • entry
    Required*
    string

    Entry name or id

Request Body

Entry

Response

Response Body

Entry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Entry object by name or id

Delete the Entry object by name or id

DELETE /orgs/{org}/truststores/{truststore}/entries/{entry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • truststore
    Required*
    string

    Truststore name or id

  • entry
    Required*
    string

    Entry name or id

Response

Response Body

Entry

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Catalog Setting object

Get the Catalog Setting object

GET /catalogs/{org}/{catalog}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

CatalogSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Catalog Setting object

Update the Catalog Setting object

PUT /catalogs/{org}/{catalog}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

CatalogSetting

Response

Response Body

CatalogSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured Gateway Service object

Create a Configured Gateway Service object

POST /catalogs/{org}/{catalog}/configured-gateway-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

ConfiguredGatewayService

Response

Response Body

ConfiguredGatewayService

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured Gateway Service objects

List the Configured Gateway Service objects

GET /catalogs/{org}/{catalog}/configured-gateway-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredGatewayServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured Gateway Service objects

Clear the Configured Gateway Service objects

DELETE /catalogs/{org}/{catalog}/configured-gateway-services

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured Gateway Service object by name or id

Get the Configured Gateway Service object by name or id

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredGatewayService

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured Gateway Service object by name or id

Delete the Configured Gateway Service object by name or id

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Response

Response Body

ConfiguredGatewayService

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured Catalog User Registry object

Create a Configured Catalog User Registry object

POST /catalogs/{org}/{catalog}/configured-catalog-user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

ConfiguredCatalogUserRegistry

Response

Response Body

ConfiguredCatalogUserRegistry

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured Catalog User Registry objects

List the Configured Catalog User Registry objects

GET /catalogs/{org}/{catalog}/configured-catalog-user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredCatalogUserRegistryList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured Catalog User Registry object by name or id

Get the Configured Catalog User Registry object by name or id

GET /catalogs/{org}/{catalog}/configured-catalog-user-registries/{configured-catalog-user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-catalog-user-registry
    Required*
    string

    Configured Catalog User Registry name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredCatalogUserRegistry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured Catalog User Registry object by name or id

Delete the Configured Catalog User Registry object by name or id

DELETE /catalogs/{org}/{catalog}/configured-catalog-user-registries/{configured-catalog-user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-catalog-user-registry
    Required*
    string

    Configured Catalog User Registry name or id

Response

Response Body

ConfiguredCatalogUserRegistry

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured API User Registry object

Create a Configured API User Registry object

POST /catalogs/{org}/{catalog}/configured-api-user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

ConfiguredAPIUserRegistry

Response

Response Body

ConfiguredAPIUserRegistry

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured API User Registry objects

List the Configured API User Registry objects

GET /catalogs/{org}/{catalog}/configured-api-user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredAPIUserRegistryList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured API User Registry objects

Clear the Configured API User Registry objects

DELETE /catalogs/{org}/{catalog}/configured-api-user-registries

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured API User Registry object by name or id

Get the Configured API User Registry object by name or id

GET /catalogs/{org}/{catalog}/configured-api-user-registries/{configured-api-user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-api-user-registry
    Required*
    string

    Configured API User Registry name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredAPIUserRegistry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured API User Registry object by name or id

Delete the Configured API User Registry object by name or id

DELETE /catalogs/{org}/{catalog}/configured-api-user-registries/{configured-api-user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-api-user-registry
    Required*
    string

    Configured API User Registry name or id

Response

Response Body

ConfiguredAPIUserRegistry

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured TLS Client Profile object

Create a Configured TLS Client Profile object

POST /catalogs/{org}/{catalog}/configured-tls-client-profiles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

ConfiguredTLSClientProfile

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Configured TLS Client Profile objects in all collections

List all Configured TLS Client Profile objects in all collections

GET /catalogs/{org}/{catalog}/configured-tls-client-profiles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredTLSClientProfileList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Configured TLS Client Profile objects in all collections

Clear all Configured TLS Client Profile objects in all collections

DELETE /catalogs/{org}/{catalog}/configured-tls-client-profiles

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured TLS Client Profile objects

List the Configured TLS Client Profile objects

GET /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredTLSClientProfileList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured TLS Client Profile objects

Clear the Configured TLS Client Profile objects

DELETE /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured TLS Client Profile object by id

Get the Configured TLS Client Profile object by id

GET /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-tls-client-profile-id
    Required*
    string

    Configured TLS Client Profile name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured TLS Client Profile object by id

Delete the Configured TLS Client Profile object by id

DELETE /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-tls-client-profile-id
    Required*
    string

    Configured TLS Client Profile name

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured TLS Client Profile object by name and version

Get the Configured TLS Client Profile object by name and version

GET /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

  • configured-tls-client-profile-version
    Required*
    string

    Configured TLS Client Profile version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Configured TLS Client Profile

Delete a Configured TLS Client Profile

DELETE /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

  • configured-tls-client-profile-version
    Required*
    string

    Configured TLS Client Profile version name

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured Billing object

Create a Configured Billing object

POST /catalogs/{org}/{catalog}/configured-billings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

ConfiguredBilling

Response

Response Body

ConfiguredBilling

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured Billing objects

List the Configured Billing objects

GET /catalogs/{org}/{catalog}/configured-billings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredBillingList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured Billing objects

Clear the Configured Billing objects

DELETE /catalogs/{org}/{catalog}/configured-billings

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured Billing object by name or id

Get the Configured Billing object by name or id

GET /catalogs/{org}/{catalog}/configured-billings/{configured-billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-billing
    Required*
    string

    Configured Billing name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredBilling

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured Billing object by name or id

Delete the Configured Billing object by name or id

DELETE /catalogs/{org}/{catalog}/configured-billings/{configured-billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-billing
    Required*
    string

    Configured Billing name or id

Response

Response Body

ConfiguredBilling

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured Oauth Provider object

Create a Configured Oauth Provider object

POST /catalogs/{org}/{catalog}/configured-oauth-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

ConfiguredOauthProvider

Response

Response Body

ConfiguredOauthProvider

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured Oauth Provider objects

List the Configured Oauth Provider objects

GET /catalogs/{org}/{catalog}/configured-oauth-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredOauthProviderList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured Oauth Provider objects

Clear the Configured Oauth Provider objects

DELETE /catalogs/{org}/{catalog}/configured-oauth-providers

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured Oauth Provider object by name or id

Get the Configured Oauth Provider object by name or id

GET /catalogs/{org}/{catalog}/configured-oauth-providers/{configured-oauth-provider}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-oauth-provider
    Required*
    string

    Configured Oauth Provider name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredOauthProvider

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured Oauth Provider object by name or id

Delete the Configured Oauth Provider object by name or id

DELETE /catalogs/{org}/{catalog}/configured-oauth-providers/{configured-oauth-provider}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-oauth-provider
    Required*
    string

    Configured Oauth Provider name or id

Response

Response Body

ConfiguredOauthProvider

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Notification Template objects in all collections

List all Notification Template objects in all collections

GET /catalogs/{org}/{catalog}/settings/notification-templates

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /catalogs/{org}/{catalog}/settings/notification-templates/catalog

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /catalogs/{org}/{catalog}/settings/notification-templates/catalog/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /catalogs/{org}/{catalog}/settings/notification-templates/catalog/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /catalogs/{org}/{catalog}/settings/notification-templates/space

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /catalogs/{org}/{catalog}/settings/notification-templates/space/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /catalogs/{org}/{catalog}/settings/notification-templates/space/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /catalogs/{org}/{catalog}/settings/notification-templates/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /catalogs/{org}/{catalog}/settings/notification-templates/consumer/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /catalogs/{org}/{catalog}/settings/notification-templates/consumer/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Role Default objects in all collections

List all Role Default objects in all collections

GET /catalogs/{org}/{catalog}/role-defaults

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleDefaultList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Role Default object

Create a Role Default object

POST /catalogs/{org}/{catalog}/role-defaults/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

RoleDefault

Response

Response Body

RoleDefault

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role Default objects

List the Role Default objects

GET /catalogs/{org}/{catalog}/role-defaults/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleDefaultList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Role Default objects

Clear the Role Default objects

DELETE /catalogs/{org}/{catalog}/role-defaults/consumer

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role Default object by name or id

Get the Role Default object by name or id

GET /catalogs/{org}/{catalog}/role-defaults/consumer/{role-default}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • role-default
    Required*
    string

    Role Default name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

RoleDefault

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role Default object by name or id

Update the Role Default object by name or id

PATCH /catalogs/{org}/{catalog}/role-defaults/consumer/{role-default}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • role-default
    Required*
    string

    Role Default name or id

Request Body

RoleDefault

Response

Response Body

RoleDefault

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Role Default object by name or id

Delete the Role Default object by name or id

DELETE /catalogs/{org}/{catalog}/role-defaults/consumer/{role-default}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • role-default
    Required*
    string

    Role Default name or id

Response

Response Body

RoleDefault

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Augment the Configuration Property with additional name/value pairs

Augment the Configuration Property with additional name/value pairs

PATCH /catalogs/{org}/{catalog}/properties

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

object

Response

Response Body

object

Status Code

  • 200

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configuration Property objects

List the Configuration Property objects

GET /catalogs/{org}/{catalog}/properties

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configuration Property objects

Clear the Configuration Property objects

DELETE /catalogs/{org}/{catalog}/properties

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configuration Property object

Get the Configuration Property object

GET /catalogs/{org}/{catalog}/properties/{property-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • property-name
    Required*
    string

    Configuration Property name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Configuration Property object

Update the Configuration Property object

PATCH /catalogs/{org}/{catalog}/properties/{property-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • property-name
    Required*
    string

    Configuration Property name

Request Body

object

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configuration Property object

Delete the Configuration Property object

DELETE /catalogs/{org}/{catalog}/properties/{property-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • property-name
    Required*
    string

    Configuration Property name

Response

Response Body

object

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Catalog Setting object

Get the Catalog Setting object

GET /catalogs/{org}/{catalog}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

CatalogSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Catalog Setting object

Update the Catalog Setting object

PUT /catalogs/{org}/{catalog}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

CatalogSetting

Response

Response Body

CatalogSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured Gateway Service object

Create a Configured Gateway Service object

POST /catalogs/{org}/{catalog}/configured-gateway-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

ConfiguredGatewayService

Response

Response Body

ConfiguredGatewayService

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured Gateway Service objects

List the Configured Gateway Service objects

GET /catalogs/{org}/{catalog}/configured-gateway-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredGatewayServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured Gateway Service objects

Clear the Configured Gateway Service objects

DELETE /catalogs/{org}/{catalog}/configured-gateway-services

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured Gateway Service object by name or id

Get the Configured Gateway Service object by name or id

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredGatewayService

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured Gateway Service object by name or id

Delete the Configured Gateway Service object by name or id

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Response

Response Body

ConfiguredGatewayService

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured Gateway Service object

Create a Configured Gateway Service object

POST /spaces/{org}/{catalog}/{space}/configured-gateway-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

ConfiguredGatewayService

Response

Response Body

ConfiguredGatewayService

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured Gateway Service objects

List the Configured Gateway Service objects

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredGatewayServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured Gateway Service objects

Clear the Configured Gateway Service objects

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured Gateway Service object by name or id

Get the Configured Gateway Service object by name or id

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredGatewayService

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured Gateway Service object by name or id

Delete the Configured Gateway Service object by name or id

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Response

Response Body

ConfiguredGatewayService

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured API User Registry object

Create a Configured API User Registry object

POST /spaces/{org}/{catalog}/{space}/configured-api-user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

ConfiguredAPIUserRegistry

Response

Response Body

ConfiguredAPIUserRegistry

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured API User Registry objects

List the Configured API User Registry objects

GET /spaces/{org}/{catalog}/{space}/configured-api-user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredAPIUserRegistryList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured API User Registry objects

Clear the Configured API User Registry objects

DELETE /spaces/{org}/{catalog}/{space}/configured-api-user-registries

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured API User Registry object by name or id

Get the Configured API User Registry object by name or id

GET /spaces/{org}/{catalog}/{space}/configured-api-user-registries/{configured-api-user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-api-user-registry
    Required*
    string

    Configured API User Registry name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredAPIUserRegistry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured API User Registry object by name or id

Delete the Configured API User Registry object by name or id

DELETE /spaces/{org}/{catalog}/{space}/configured-api-user-registries/{configured-api-user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-api-user-registry
    Required*
    string

    Configured API User Registry name or id

Response

Response Body

ConfiguredAPIUserRegistry

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured TLS Client Profile object

Create a Configured TLS Client Profile object

POST /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

ConfiguredTLSClientProfile

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Configured TLS Client Profile objects in all collections

List all Configured TLS Client Profile objects in all collections

GET /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredTLSClientProfileList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Configured TLS Client Profile objects in all collections

Clear all Configured TLS Client Profile objects in all collections

DELETE /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured TLS Client Profile objects

List the Configured TLS Client Profile objects

GET /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredTLSClientProfileList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured TLS Client Profile objects

Clear the Configured TLS Client Profile objects

DELETE /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured TLS Client Profile object by id

Get the Configured TLS Client Profile object by id

GET /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-tls-client-profile-id
    Required*
    string

    Configured TLS Client Profile name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured TLS Client Profile object by id

Delete the Configured TLS Client Profile object by id

DELETE /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-tls-client-profile-id
    Required*
    string

    Configured TLS Client Profile name

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured TLS Client Profile object by name and version

Get the Configured TLS Client Profile object by name and version

GET /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

  • configured-tls-client-profile-version
    Required*
    string

    Configured TLS Client Profile version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Configured TLS Client Profile

Delete a Configured TLS Client Profile

DELETE /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

  • configured-tls-client-profile-version
    Required*
    string

    Configured TLS Client Profile version name

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured Billing object

Create a Configured Billing object

POST /spaces/{org}/{catalog}/{space}/configured-billings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

ConfiguredBilling

Response

Response Body

ConfiguredBilling

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured Billing objects

List the Configured Billing objects

GET /spaces/{org}/{catalog}/{space}/configured-billings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredBillingList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured Billing objects

Clear the Configured Billing objects

DELETE /spaces/{org}/{catalog}/{space}/configured-billings

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured Billing object by name or id

Get the Configured Billing object by name or id

GET /spaces/{org}/{catalog}/{space}/configured-billings/{configured-billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-billing
    Required*
    string

    Configured Billing name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredBilling

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured Billing object by name or id

Delete the Configured Billing object by name or id

DELETE /spaces/{org}/{catalog}/{space}/configured-billings/{configured-billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-billing
    Required*
    string

    Configured Billing name or id

Response

Response Body

ConfiguredBilling

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured Oauth Provider object

Create a Configured Oauth Provider object

POST /spaces/{org}/{catalog}/{space}/configured-oauth-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

ConfiguredOauthProvider

Response

Response Body

ConfiguredOauthProvider

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured Oauth Provider objects

List the Configured Oauth Provider objects

GET /spaces/{org}/{catalog}/{space}/configured-oauth-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredOauthProviderList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured Oauth Provider objects

Clear the Configured Oauth Provider objects

DELETE /spaces/{org}/{catalog}/{space}/configured-oauth-providers

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured Oauth Provider object by name or id

Get the Configured Oauth Provider object by name or id

GET /spaces/{org}/{catalog}/{space}/configured-oauth-providers/{configured-oauth-provider}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-oauth-provider
    Required*
    string

    Configured Oauth Provider name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredOauthProvider

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured Oauth Provider object by name or id

Delete the Configured Oauth Provider object by name or id

DELETE /spaces/{org}/{catalog}/{space}/configured-oauth-providers/{configured-oauth-provider}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-oauth-provider
    Required*
    string

    Configured Oauth Provider name or id

Response

Response Body

ConfiguredOauthProvider

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Space Setting object

Get the Space Setting object

GET /spaces/{org}/{catalog}/{space}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

SpaceSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Space Setting object

Update the Space Setting object

PUT /spaces/{org}/{catalog}/{space}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

SpaceSetting

Response

Response Body

SpaceSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Notification Template objects in all collections

List all Notification Template objects in all collections

GET /spaces/{org}/{catalog}/{space}/settings/notification-templates

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /spaces/{org}/{catalog}/{space}/settings/notification-templates/space

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /spaces/{org}/{catalog}/{space}/settings/notification-templates/space/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /spaces/{org}/{catalog}/{space}/settings/notification-templates/space/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /spaces/{org}/{catalog}/{space}/settings/notification-templates/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /spaces/{org}/{catalog}/{space}/settings/notification-templates/consumer/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /spaces/{org}/{catalog}/{space}/settings/notification-templates/consumer/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Role Default objects in all collections

List all Role Default objects in all collections

GET /spaces/{org}/{catalog}/{space}/role-defaults

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleDefaultList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Role Default object

Create a Role Default object

POST /spaces/{org}/{catalog}/{space}/role-defaults/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

RoleDefault

Response

Response Body

RoleDefault

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role Default objects

List the Role Default objects

GET /spaces/{org}/{catalog}/{space}/role-defaults/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleDefaultList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Role Default objects

Clear the Role Default objects

DELETE /spaces/{org}/{catalog}/{space}/role-defaults/consumer

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role Default object by name or id

Get the Role Default object by name or id

GET /spaces/{org}/{catalog}/{space}/role-defaults/consumer/{role-default}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • role-default
    Required*
    string

    Role Default name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

RoleDefault

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role Default object by name or id

Update the Role Default object by name or id

PATCH /spaces/{org}/{catalog}/{space}/role-defaults/consumer/{role-default}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • role-default
    Required*
    string

    Role Default name or id

Request Body

RoleDefault

Response

Response Body

RoleDefault

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Role Default object by name or id

Delete the Role Default object by name or id

DELETE /spaces/{org}/{catalog}/{space}/role-defaults/consumer/{role-default}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • role-default
    Required*
    string

    Role Default name or id

Response

Response Body

RoleDefault

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured Gateway Service object

Create a Configured Gateway Service object

POST /spaces/{org}/{catalog}/{space}/configured-gateway-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

ConfiguredGatewayService

Response

Response Body

ConfiguredGatewayService

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured Gateway Service objects

List the Configured Gateway Service objects

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredGatewayServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured Gateway Service objects

Clear the Configured Gateway Service objects

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured Gateway Service object by name or id

Get the Configured Gateway Service object by name or id

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredGatewayService

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured Gateway Service object by name or id

Delete the Configured Gateway Service object by name or id

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Response

Response Body

ConfiguredGatewayService

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured Catalog User Registry object

Create a Configured Catalog User Registry object

POST /catalogs/{org}/{catalog}/configured-catalog-user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

ConfiguredCatalogUserRegistry

Response

Response Body

ConfiguredCatalogUserRegistry

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured Catalog User Registry objects

List the Configured Catalog User Registry objects

GET /catalogs/{org}/{catalog}/configured-catalog-user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredCatalogUserRegistryList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured Catalog User Registry object by name or id

Get the Configured Catalog User Registry object by name or id

GET /catalogs/{org}/{catalog}/configured-catalog-user-registries/{configured-catalog-user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-catalog-user-registry
    Required*
    string

    Configured Catalog User Registry name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredCatalogUserRegistry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured Catalog User Registry object by name or id

Delete the Configured Catalog User Registry object by name or id

DELETE /catalogs/{org}/{catalog}/configured-catalog-user-registries/{configured-catalog-user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-catalog-user-registry
    Required*
    string

    Configured Catalog User Registry name or id

Response

Response Body

ConfiguredCatalogUserRegistry

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured API User Registry object

Create a Configured API User Registry object

POST /catalogs/{org}/{catalog}/configured-api-user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

ConfiguredAPIUserRegistry

Response

Response Body

ConfiguredAPIUserRegistry

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured API User Registry objects

List the Configured API User Registry objects

GET /catalogs/{org}/{catalog}/configured-api-user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredAPIUserRegistryList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured API User Registry objects

Clear the Configured API User Registry objects

DELETE /catalogs/{org}/{catalog}/configured-api-user-registries

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured API User Registry object by name or id

Get the Configured API User Registry object by name or id

GET /catalogs/{org}/{catalog}/configured-api-user-registries/{configured-api-user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-api-user-registry
    Required*
    string

    Configured API User Registry name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredAPIUserRegistry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured API User Registry object by name or id

Delete the Configured API User Registry object by name or id

DELETE /catalogs/{org}/{catalog}/configured-api-user-registries/{configured-api-user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-api-user-registry
    Required*
    string

    Configured API User Registry name or id

Response

Response Body

ConfiguredAPIUserRegistry

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured API User Registry object

Create a Configured API User Registry object

POST /spaces/{org}/{catalog}/{space}/configured-api-user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

ConfiguredAPIUserRegistry

Response

Response Body

ConfiguredAPIUserRegistry

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured API User Registry objects

List the Configured API User Registry objects

GET /spaces/{org}/{catalog}/{space}/configured-api-user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredAPIUserRegistryList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured API User Registry objects

Clear the Configured API User Registry objects

DELETE /spaces/{org}/{catalog}/{space}/configured-api-user-registries

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured API User Registry object by name or id

Get the Configured API User Registry object by name or id

GET /spaces/{org}/{catalog}/{space}/configured-api-user-registries/{configured-api-user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-api-user-registry
    Required*
    string

    Configured API User Registry name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredAPIUserRegistry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured API User Registry object by name or id

Delete the Configured API User Registry object by name or id

DELETE /spaces/{org}/{catalog}/{space}/configured-api-user-registries/{configured-api-user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-api-user-registry
    Required*
    string

    Configured API User Registry name or id

Response

Response Body

ConfiguredAPIUserRegistry

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured TLS Client Profile object

Create a Configured TLS Client Profile object

POST /catalogs/{org}/{catalog}/configured-tls-client-profiles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

ConfiguredTLSClientProfile

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Configured TLS Client Profile objects in all collections

List all Configured TLS Client Profile objects in all collections

GET /catalogs/{org}/{catalog}/configured-tls-client-profiles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredTLSClientProfileList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Configured TLS Client Profile objects in all collections

Clear all Configured TLS Client Profile objects in all collections

DELETE /catalogs/{org}/{catalog}/configured-tls-client-profiles

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured TLS Client Profile objects

List the Configured TLS Client Profile objects

GET /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredTLSClientProfileList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured TLS Client Profile objects

Clear the Configured TLS Client Profile objects

DELETE /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured TLS Client Profile object by id

Get the Configured TLS Client Profile object by id

GET /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-tls-client-profile-id
    Required*
    string

    Configured TLS Client Profile name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured TLS Client Profile object by id

Delete the Configured TLS Client Profile object by id

DELETE /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-tls-client-profile-id
    Required*
    string

    Configured TLS Client Profile name

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured TLS Client Profile object by name and version

Get the Configured TLS Client Profile object by name and version

GET /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

  • configured-tls-client-profile-version
    Required*
    string

    Configured TLS Client Profile version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Configured TLS Client Profile

Delete a Configured TLS Client Profile

DELETE /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

  • configured-tls-client-profile-version
    Required*
    string

    Configured TLS Client Profile version name

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured TLS Client Profile object

Create a Configured TLS Client Profile object

POST /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

ConfiguredTLSClientProfile

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Configured TLS Client Profile objects in all collections

List all Configured TLS Client Profile objects in all collections

GET /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredTLSClientProfileList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Configured TLS Client Profile objects in all collections

Clear all Configured TLS Client Profile objects in all collections

DELETE /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured TLS Client Profile objects

List the Configured TLS Client Profile objects

GET /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredTLSClientProfileList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured TLS Client Profile objects

Clear the Configured TLS Client Profile objects

DELETE /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured TLS Client Profile object by id

Get the Configured TLS Client Profile object by id

GET /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-tls-client-profile-id
    Required*
    string

    Configured TLS Client Profile name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured TLS Client Profile object by id

Delete the Configured TLS Client Profile object by id

DELETE /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-tls-client-profile-id
    Required*
    string

    Configured TLS Client Profile name

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured TLS Client Profile object by name and version

Get the Configured TLS Client Profile object by name and version

GET /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

  • configured-tls-client-profile-version
    Required*
    string

    Configured TLS Client Profile version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Configured TLS Client Profile

Delete a Configured TLS Client Profile

DELETE /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-tls-client-profile-name
    Required*
    string

    Configured TLS Client Profile name

  • configured-tls-client-profile-version
    Required*
    string

    Configured TLS Client Profile version name

Response

Response Body

ConfiguredTLSClientProfile

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured Billing object

Create a Configured Billing object

POST /catalogs/{org}/{catalog}/configured-billings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

ConfiguredBilling

Response

Response Body

ConfiguredBilling

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured Billing objects

List the Configured Billing objects

GET /catalogs/{org}/{catalog}/configured-billings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredBillingList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured Billing objects

Clear the Configured Billing objects

DELETE /catalogs/{org}/{catalog}/configured-billings

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured Billing object by name or id

Get the Configured Billing object by name or id

GET /catalogs/{org}/{catalog}/configured-billings/{configured-billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-billing
    Required*
    string

    Configured Billing name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredBilling

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured Billing object by name or id

Delete the Configured Billing object by name or id

DELETE /catalogs/{org}/{catalog}/configured-billings/{configured-billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-billing
    Required*
    string

    Configured Billing name or id

Response

Response Body

ConfiguredBilling

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured Billing object

Create a Configured Billing object

POST /spaces/{org}/{catalog}/{space}/configured-billings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

ConfiguredBilling

Response

Response Body

ConfiguredBilling

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured Billing objects

List the Configured Billing objects

GET /spaces/{org}/{catalog}/{space}/configured-billings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredBillingList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured Billing objects

Clear the Configured Billing objects

DELETE /spaces/{org}/{catalog}/{space}/configured-billings

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured Billing object by name or id

Get the Configured Billing object by name or id

GET /spaces/{org}/{catalog}/{space}/configured-billings/{configured-billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-billing
    Required*
    string

    Configured Billing name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredBilling

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured Billing object by name or id

Delete the Configured Billing object by name or id

DELETE /spaces/{org}/{catalog}/{space}/configured-billings/{configured-billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-billing
    Required*
    string

    Configured Billing name or id

Response

Response Body

ConfiguredBilling

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured Oauth Provider object

Create a Configured Oauth Provider object

POST /catalogs/{org}/{catalog}/configured-oauth-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

ConfiguredOauthProvider

Response

Response Body

ConfiguredOauthProvider

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured Oauth Provider objects

List the Configured Oauth Provider objects

GET /catalogs/{org}/{catalog}/configured-oauth-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredOauthProviderList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured Oauth Provider objects

Clear the Configured Oauth Provider objects

DELETE /catalogs/{org}/{catalog}/configured-oauth-providers

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured Oauth Provider object by name or id

Get the Configured Oauth Provider object by name or id

GET /catalogs/{org}/{catalog}/configured-oauth-providers/{configured-oauth-provider}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-oauth-provider
    Required*
    string

    Configured Oauth Provider name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredOauthProvider

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured Oauth Provider object by name or id

Delete the Configured Oauth Provider object by name or id

DELETE /catalogs/{org}/{catalog}/configured-oauth-providers/{configured-oauth-provider}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-oauth-provider
    Required*
    string

    Configured Oauth Provider name or id

Response

Response Body

ConfiguredOauthProvider

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Configured Oauth Provider object

Create a Configured Oauth Provider object

POST /spaces/{org}/{catalog}/{space}/configured-oauth-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

ConfiguredOauthProvider

Response

Response Body

ConfiguredOauthProvider

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configured Oauth Provider objects

List the Configured Oauth Provider objects

GET /spaces/{org}/{catalog}/{space}/configured-oauth-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConfiguredOauthProviderList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configured Oauth Provider objects

Clear the Configured Oauth Provider objects

DELETE /spaces/{org}/{catalog}/{space}/configured-oauth-providers

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configured Oauth Provider object by name or id

Get the Configured Oauth Provider object by name or id

GET /spaces/{org}/{catalog}/{space}/configured-oauth-providers/{configured-oauth-provider}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-oauth-provider
    Required*
    string

    Configured Oauth Provider name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConfiguredOauthProvider

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configured Oauth Provider object by name or id

Delete the Configured Oauth Provider object by name or id

DELETE /spaces/{org}/{catalog}/{space}/configured-oauth-providers/{configured-oauth-provider}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-oauth-provider
    Required*
    string

    Configured Oauth Provider name or id

Response

Response Body

ConfiguredOauthProvider

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Notification Template objects in all collections

List all Notification Template objects in all collections

GET /catalogs/{org}/{catalog}/settings/notification-templates

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /catalogs/{org}/{catalog}/settings/notification-templates/catalog

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /catalogs/{org}/{catalog}/settings/notification-templates/catalog/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /catalogs/{org}/{catalog}/settings/notification-templates/catalog/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /catalogs/{org}/{catalog}/settings/notification-templates/space

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /catalogs/{org}/{catalog}/settings/notification-templates/space/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /catalogs/{org}/{catalog}/settings/notification-templates/space/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /catalogs/{org}/{catalog}/settings/notification-templates/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /catalogs/{org}/{catalog}/settings/notification-templates/consumer/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /catalogs/{org}/{catalog}/settings/notification-templates/consumer/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Role Default objects in all collections

List all Role Default objects in all collections

GET /catalogs/{org}/{catalog}/role-defaults

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleDefaultList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Role Default object

Create a Role Default object

POST /catalogs/{org}/{catalog}/role-defaults/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

RoleDefault

Response

Response Body

RoleDefault

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role Default objects

List the Role Default objects

GET /catalogs/{org}/{catalog}/role-defaults/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleDefaultList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Role Default objects

Clear the Role Default objects

DELETE /catalogs/{org}/{catalog}/role-defaults/consumer

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role Default object by name or id

Get the Role Default object by name or id

GET /catalogs/{org}/{catalog}/role-defaults/consumer/{role-default}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • role-default
    Required*
    string

    Role Default name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

RoleDefault

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role Default object by name or id

Update the Role Default object by name or id

PATCH /catalogs/{org}/{catalog}/role-defaults/consumer/{role-default}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • role-default
    Required*
    string

    Role Default name or id

Request Body

RoleDefault

Response

Response Body

RoleDefault

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Role Default object by name or id

Delete the Role Default object by name or id

DELETE /catalogs/{org}/{catalog}/role-defaults/consumer/{role-default}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • role-default
    Required*
    string

    Role Default name or id

Response

Response Body

RoleDefault

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Augment the Configuration Property with additional name/value pairs

Augment the Configuration Property with additional name/value pairs

PATCH /catalogs/{org}/{catalog}/properties

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

object

Response

Response Body

object

Status Code

  • 200

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Configuration Property objects

List the Configuration Property objects

GET /catalogs/{org}/{catalog}/properties

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Configuration Property objects

Clear the Configuration Property objects

DELETE /catalogs/{org}/{catalog}/properties

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Configuration Property object

Get the Configuration Property object

GET /catalogs/{org}/{catalog}/properties/{property-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • property-name
    Required*
    string

    Configuration Property name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Configuration Property object

Update the Configuration Property object

PATCH /catalogs/{org}/{catalog}/properties/{property-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • property-name
    Required*
    string

    Configuration Property name

Request Body

object

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Configuration Property object

Delete the Configuration Property object

DELETE /catalogs/{org}/{catalog}/properties/{property-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • property-name
    Required*
    string

    Configuration Property name

Response

Response Body

object

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Catalog object

Create a Catalog object

POST /orgs/{org}/catalogs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Catalog

Response

Response Body

Catalog

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Catalog objects

List the Catalog objects

GET /orgs/{org}/catalogs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

CatalogList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Catalog objects

Clear the Catalog objects

DELETE /orgs/{org}/catalogs

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Catalog object by name or id

Get the Catalog object by name or id

GET /catalogs/{org}/{catalog}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Catalog

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Catalog object by name or id

Update the Catalog object by name or id

PATCH /catalogs/{org}/{catalog}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

Catalog

Response

Response Body

Catalog

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Catalog object by name or id

Delete the Catalog object by name or id

DELETE /catalogs/{org}/{catalog}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Response

Response Body

Catalog

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Transfer owner to an associate

Transfer owner to an associate

POST /catalogs/{org}/{catalog}/transfer-owner

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

TransferOwner

Response

Response Body

Catalog

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Send email

Send email

POST /catalogs/{org}/{catalog}/send-email

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

SendEmail

Response

Status Code

  • 204

    Success

  • 400

    Failure

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Stage a draft product

Stage a draft product

POST /catalogs/{org}/{catalog}/stage-draft-product

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Request Body

DraftProductPublish

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Publish a draft product

Publish a draft product

POST /catalogs/{org}/{catalog}/publish-draft-product

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Request Body

DraftProductPublish

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Stage the product

Stage the product

POST /catalogs/{org}/{catalog}/stage

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Form Parameters

  • product
    Required*
  • openapi
    Required*
  • gateway_service_urls
    string[]
  • wsdl
  • metadata

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Publish the product

Publish the product

POST /catalogs/{org}/{catalog}/publish

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Form Parameters

  • product
    Required*
  • openapi
    Required*
  • gateway_service_urls
    string[]
  • wsdl
  • metadata

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Catalog Invitation object

Create a Catalog Invitation object

POST /orgs/{org}/catalog-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Catalog Invitation objects

List the Catalog Invitation objects

GET /orgs/{org}/catalog-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

InvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Catalog Invitation objects

Clear the Catalog Invitation objects

DELETE /orgs/{org}/catalog-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Catalog Invitation object by name or id

Get the Catalog Invitation object by name or id

GET /orgs/{org}/catalog-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Catalog Invitation object by name or id

Update the Catalog Invitation object by name or id

PATCH /orgs/{org}/catalog-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Catalog Invitation object by name or id

Delete the Catalog Invitation object by name or id

DELETE /orgs/{org}/catalog-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Response

Response Body

Invitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Catalog Invitation

Regenerate the Catalog Invitation

POST /orgs/{org}/catalog-invitations/{invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Regenerate

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Register using the Catalog Invitation

Register using the Catalog Invitation

POST /orgs/{org}/catalog-invitations/{invitation}/register

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

InvitationRegister

Response

Response Body

MemberRegisterResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Accept using the Catalog Invitation

Accept using the Catalog Invitation

POST /orgs/{org}/catalog-invitations/{invitation}/accept

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

InvitationAccept

Response

Response Body

MemberAcceptResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member Invitation object

Create a Member Invitation object

POST /catalogs/{org}/{catalog}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member Invitation objects

List the Member Invitation objects

GET /catalogs/{org}/{catalog}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberInvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member Invitation objects

Clear the Member Invitation objects

DELETE /catalogs/{org}/{catalog}/member-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member Invitation object by name or id

Get the Member Invitation object by name or id

GET /catalogs/{org}/{catalog}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member Invitation object by name or id

Update the Member Invitation object by name or id

PATCH /catalogs/{org}/{catalog}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member Invitation object by name or id

Delete the Member Invitation object by name or id

DELETE /catalogs/{org}/{catalog}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Response

Response Body

MemberInvitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Member Invitation

Regenerate the Member Invitation

POST /catalogs/{org}/{catalog}/member-invitations/{member-invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

Regenerate

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Register using the Member Invitation

Register using the Member Invitation

POST /catalogs/{org}/{catalog}/member-invitations/{member-invitation}/register

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationRegister

Response

Response Body

MemberRegisterResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Accept using the Member Invitation

Accept using the Member Invitation

POST /catalogs/{org}/{catalog}/member-invitations/{member-invitation}/accept

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationAccept

Response

Response Body

MemberAcceptResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member object

Create a Member object

POST /catalogs/{org}/{catalog}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member objects

List the Member objects

GET /catalogs/{org}/{catalog}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member objects

Clear the Member objects

DELETE /catalogs/{org}/{catalog}/members

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member object by name or id

Get the Member object by name or id

GET /catalogs/{org}/{catalog}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member
    Required*
    string

    Member name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member object by name or id

Update the Member object by name or id

PATCH /catalogs/{org}/{catalog}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member
    Required*
    string

    Member name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member object by name or id

Delete the Member object by name or id

DELETE /catalogs/{org}/{catalog}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member
    Required*
    string

    Member name or id

Response

Response Body

Member

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Task objects

List the Task objects

GET /catalogs/{org}/{catalog}/tasks

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

TaskList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Task object by name or id

Get the Task object by name or id

GET /catalogs/{org}/{catalog}/tasks/{task}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • task
    Required*
    string

    Task name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Task

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Task object by name or id

Update the Task object by name or id

PATCH /catalogs/{org}/{catalog}/tasks/{task}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • task
    Required*
    string

    Task name or id

Request Body

Task

Response

Response Body

Task

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role objects

List the Role objects

GET /catalogs/{org}/{catalog}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role object by name or id

Get the Role object by name or id

GET /catalogs/{org}/{catalog}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • role
    Required*
    string

    Role name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role object by name or id

Update the Role object by name or id

PATCH /catalogs/{org}/{catalog}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • role
    Required*
    string

    Role name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Catalog object

Create a Catalog object

POST /orgs/{org}/catalogs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Catalog

Response

Response Body

Catalog

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Catalog objects

List the Catalog objects

GET /orgs/{org}/catalogs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

CatalogList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Catalog objects

Clear the Catalog objects

DELETE /orgs/{org}/catalogs

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Catalog object by name or id

Get the Catalog object by name or id

GET /catalogs/{org}/{catalog}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Catalog

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Catalog object by name or id

Update the Catalog object by name or id

PATCH /catalogs/{org}/{catalog}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

Catalog

Response

Response Body

Catalog

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Catalog object by name or id

Delete the Catalog object by name or id

DELETE /catalogs/{org}/{catalog}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Response

Response Body

Catalog

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Transfer owner to an associate

Transfer owner to an associate

POST /catalogs/{org}/{catalog}/transfer-owner

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

TransferOwner

Response

Response Body

Catalog

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Send email

Send email

POST /catalogs/{org}/{catalog}/send-email

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

SendEmail

Response

Status Code

  • 204

    Success

  • 400

    Failure

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Stage a draft product

Stage a draft product

POST /catalogs/{org}/{catalog}/stage-draft-product

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Request Body

DraftProductPublish

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Publish a draft product

Publish a draft product

POST /catalogs/{org}/{catalog}/publish-draft-product

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Request Body

DraftProductPublish

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Stage the product

Stage the product

POST /catalogs/{org}/{catalog}/stage

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Form Parameters

  • product
    Required*
  • openapi
    Required*
  • gateway_service_urls
    string[]
  • wsdl
  • metadata

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Publish the product

Publish the product

POST /catalogs/{org}/{catalog}/publish

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Form Parameters

  • product
    Required*
  • openapi
    Required*
  • gateway_service_urls
    string[]
  • wsdl
  • metadata

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Catalog Invitation object

Create a Catalog Invitation object

POST /orgs/{org}/catalog-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Catalog Invitation objects

List the Catalog Invitation objects

GET /orgs/{org}/catalog-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

InvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Catalog Invitation objects

Clear the Catalog Invitation objects

DELETE /orgs/{org}/catalog-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Catalog Invitation object by name or id

Get the Catalog Invitation object by name or id

GET /orgs/{org}/catalog-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Catalog Invitation object by name or id

Update the Catalog Invitation object by name or id

PATCH /orgs/{org}/catalog-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Catalog Invitation object by name or id

Delete the Catalog Invitation object by name or id

DELETE /orgs/{org}/catalog-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Response

Response Body

Invitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Catalog Invitation

Regenerate the Catalog Invitation

POST /orgs/{org}/catalog-invitations/{invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Regenerate

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Register using the Catalog Invitation

Register using the Catalog Invitation

POST /orgs/{org}/catalog-invitations/{invitation}/register

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

InvitationRegister

Response

Response Body

MemberRegisterResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Accept using the Catalog Invitation

Accept using the Catalog Invitation

POST /orgs/{org}/catalog-invitations/{invitation}/accept

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

InvitationAccept

Response

Response Body

MemberAcceptResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member Invitation object

Create a Member Invitation object

POST /catalogs/{org}/{catalog}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member Invitation objects

List the Member Invitation objects

GET /catalogs/{org}/{catalog}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberInvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member Invitation objects

Clear the Member Invitation objects

DELETE /catalogs/{org}/{catalog}/member-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member Invitation object by name or id

Get the Member Invitation object by name or id

GET /catalogs/{org}/{catalog}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member Invitation object by name or id

Update the Member Invitation object by name or id

PATCH /catalogs/{org}/{catalog}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member Invitation object by name or id

Delete the Member Invitation object by name or id

DELETE /catalogs/{org}/{catalog}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Response

Response Body

MemberInvitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Member Invitation

Regenerate the Member Invitation

POST /catalogs/{org}/{catalog}/member-invitations/{member-invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

Regenerate

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Register using the Member Invitation

Register using the Member Invitation

POST /catalogs/{org}/{catalog}/member-invitations/{member-invitation}/register

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationRegister

Response

Response Body

MemberRegisterResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Accept using the Member Invitation

Accept using the Member Invitation

POST /catalogs/{org}/{catalog}/member-invitations/{member-invitation}/accept

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationAccept

Response

Response Body

MemberAcceptResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member object

Create a Member object

POST /catalogs/{org}/{catalog}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member objects

List the Member objects

GET /catalogs/{org}/{catalog}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member objects

Clear the Member objects

DELETE /catalogs/{org}/{catalog}/members

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member object by name or id

Get the Member object by name or id

GET /catalogs/{org}/{catalog}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member
    Required*
    string

    Member name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member object by name or id

Update the Member object by name or id

PATCH /catalogs/{org}/{catalog}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member
    Required*
    string

    Member name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member object by name or id

Delete the Member object by name or id

DELETE /catalogs/{org}/{catalog}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • member
    Required*
    string

    Member name or id

Response

Response Body

Member

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Task objects

List the Task objects

GET /catalogs/{org}/{catalog}/tasks

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

TaskList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Task object by name or id

Get the Task object by name or id

GET /catalogs/{org}/{catalog}/tasks/{task}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • task
    Required*
    string

    Task name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Task

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Task object by name or id

Update the Task object by name or id

PATCH /catalogs/{org}/{catalog}/tasks/{task}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • task
    Required*
    string

    Task name or id

Request Body

Task

Response

Response Body

Task

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role objects

List the Role objects

GET /catalogs/{org}/{catalog}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role object by name or id

Get the Role object by name or id

GET /catalogs/{org}/{catalog}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • role
    Required*
    string

    Role name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role object by name or id

Update the Role object by name or id

PATCH /catalogs/{org}/{catalog}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • role
    Required*
    string

    Role name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Global Policy object

Create a Global Policy object

POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicy

Response

Response Body

GlobalPolicy

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Global Policy objects in all collections

List all Global Policy objects in all collections

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

GlobalPolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Global Policy objects in all collections

Clear all Global Policy objects in all collections

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Global Policy objects

List the Global Policy objects

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

GlobalPolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Global Policy objects

Clear the Global Policy objects

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy object by id

Get the Global Policy object by id

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy object by id

Update the Global Policy object by id

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Request Body

GlobalPolicy

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Global Policy object by id

Delete the Global Policy object by id

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy object by name and version

Get the Global Policy object by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy object by name and version

Update the Global Policy object by name and version

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Request Body

GlobalPolicy

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Global Policy

Delete a Global Policy

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy document

Get the Global Policy document

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy document by name and version

Get the Global Policy document by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Policy object

Create a Policy object

POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Form Parameters

  • policy
  • implementation

Response

Response Body

Policy

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Policy objects in all collections

List all Policy objects in all collections

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Policy objects in all collections

Clear all Policy objects in all collections

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Policy objects

List the Policy objects

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Policy objects

Clear the Policy objects

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy object by id

Get the Policy object by id

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Policy object by id

Update the Policy object by id

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Request Body

Policy

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Policy object by id

Delete the Policy object by id

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Response

Response Body

Policy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy object by name and version

Get the Policy object by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Policy object by name and version

Update the Policy object by name and version

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Request Body

Policy

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Policy

Delete a Policy

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Response

Response Body

Policy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy document

Get the Policy document

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy document by name and version

Get the Policy document by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy implementation document

Get the Policy implementation document

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}/implementation

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy implementation document by name and version

Get the Policy implementation document by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}/implementation

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Extension object

Create a Extension object

POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

Extension

Response

Response Body

Extension

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Extension objects in all collections

List all Extension objects in all collections

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ExtensionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Extension objects in all collections

Clear all Extension objects in all collections

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Extension objects

List the Extension objects

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ExtensionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Extension objects

Clear the Extension objects

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension object by id

Get the Extension object by id

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Extension object by id

Update the Extension object by id

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Request Body

Extension

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Extension object by id

Delete the Extension object by id

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Response

Response Body

Extension

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension object by name and version

Get the Extension object by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Extension object by name and version

Update the Extension object by name and version

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Request Body

Extension

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Extension

Delete a Extension

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Response

Response Body

Extension

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension document

Get the Extension document

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Response

Response Body

ExtensionDocument

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension document by name and version

Get the Extension document by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Response

Response Body

ExtensionDocument

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Service object

Create a Service object

POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

Service

Response

Response Body

Service

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Service objects in all collections

List all Service objects in all collections

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Service objects in all collections

Clear all Service objects in all collections

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Service objects

List the Service objects

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Service objects

Clear the Service objects

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Service object by id

Get the Service object by id

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-id
    Required*
    string

    Service name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Service object by id

Update the Service object by id

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-id
    Required*
    string

    Service name

Request Body

Service

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Service object by id

Delete the Service object by id

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-id
    Required*
    string

    Service name

Response

Response Body

Service

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Service object by name and version

Get the Service object by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

  • service-version
    Required*
    string

    Service version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Service object by name and version

Update the Service object by name and version

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

  • service-version
    Required*
    string

    Service version name

Request Body

Service

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Service

Delete a Service

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

  • service-version
    Required*
    string

    Service version name

Response

Response Body

Service

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create the Global Policy Prehook object

Create the Global Policy Prehook object

POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPrehook

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy Prehook object

Get the Global Policy Prehook object

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy Prehook object

Update the Global Policy Prehook object

PUT /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPrehook

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Global Policy Prehook object

Delete the Global Policy Prehook object

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create the Global Policy Posthook object

Create the Global Policy Posthook object

POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPosthook

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy Posthook object

Get the Global Policy Posthook object

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy Posthook object

Update the Global Policy Posthook object

PUT /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPosthook

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Global Policy Posthook object

Delete the Global Policy Posthook object

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Analytics Service objects

List the Analytics Service objects

GET /catalogs/{org}/{catalog}/analytics-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AnalyticsServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Analytics Service object by name or id

Get the Analytics Service object by name or id

GET /catalogs/{org}/{catalog}/analytics-services/{analytics-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • analytics-service
    Required*
    string

    Analytics Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • query
    string

    Add query to request

Response

Response Body

AnalyticsService

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create an Analytics object

Create an Analytics object

POST /catalogs/{org}/{catalog}/analytics-services/{analytics-service}/analytics

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • analytics-service
    Required*
    string

    Analytics Service name or id

Query Parameters

  • query
    string

    Add query to request

Request Body

object

Response

Response Body

object

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Global Policy object

Create a Global Policy object

POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicy

Response

Response Body

GlobalPolicy

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Global Policy objects in all collections

List all Global Policy objects in all collections

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

GlobalPolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Global Policy objects in all collections

Clear all Global Policy objects in all collections

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Global Policy objects

List the Global Policy objects

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

GlobalPolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Global Policy objects

Clear the Global Policy objects

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy object by id

Get the Global Policy object by id

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy object by id

Update the Global Policy object by id

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Request Body

GlobalPolicy

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Global Policy object by id

Delete the Global Policy object by id

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy object by name and version

Get the Global Policy object by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy object by name and version

Update the Global Policy object by name and version

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Request Body

GlobalPolicy

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Global Policy

Delete a Global Policy

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy document

Get the Global Policy document

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy document by name and version

Get the Global Policy document by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Global Policy object

Create a Global Policy object

POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicy

Response

Response Body

GlobalPolicy

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Global Policy objects in all collections

List all Global Policy objects in all collections

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

GlobalPolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Global Policy objects in all collections

Clear all Global Policy objects in all collections

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Global Policy objects

List the Global Policy objects

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

GlobalPolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Global Policy objects

Clear the Global Policy objects

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy object by id

Get the Global Policy object by id

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy object by id

Update the Global Policy object by id

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Request Body

GlobalPolicy

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Global Policy object by id

Delete the Global Policy object by id

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy object by name and version

Get the Global Policy object by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy object by name and version

Update the Global Policy object by name and version

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Request Body

GlobalPolicy

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Global Policy

Delete a Global Policy

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy document

Get the Global Policy document

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy document by name and version

Get the Global Policy document by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Policy object

Create a Policy object

POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Form Parameters

  • policy
  • implementation

Response

Response Body

Policy

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Policy objects in all collections

List all Policy objects in all collections

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Policy objects in all collections

Clear all Policy objects in all collections

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Policy objects

List the Policy objects

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Policy objects

Clear the Policy objects

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy object by id

Get the Policy object by id

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Policy object by id

Update the Policy object by id

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Request Body

Policy

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Policy object by id

Delete the Policy object by id

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Response

Response Body

Policy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy object by name and version

Get the Policy object by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Policy object by name and version

Update the Policy object by name and version

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Request Body

Policy

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Policy

Delete a Policy

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Response

Response Body

Policy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy document

Get the Policy document

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy document by name and version

Get the Policy document by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy implementation document

Get the Policy implementation document

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}/implementation

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy implementation document by name and version

Get the Policy implementation document by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}/implementation

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Extension object

Create a Extension object

POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

Extension

Response

Response Body

Extension

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Extension objects in all collections

List all Extension objects in all collections

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ExtensionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Extension objects in all collections

Clear all Extension objects in all collections

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Extension objects

List the Extension objects

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ExtensionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Extension objects

Clear the Extension objects

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension object by id

Get the Extension object by id

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Extension object by id

Update the Extension object by id

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Request Body

Extension

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Extension object by id

Delete the Extension object by id

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Response

Response Body

Extension

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension object by name and version

Get the Extension object by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Extension object by name and version

Update the Extension object by name and version

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Request Body

Extension

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Extension

Delete a Extension

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Response

Response Body

Extension

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension document

Get the Extension document

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Response

Response Body

ExtensionDocument

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension document by name and version

Get the Extension document by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Response

Response Body

ExtensionDocument

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Service object

Create a Service object

POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

Service

Response

Response Body

Service

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Service objects in all collections

List all Service objects in all collections

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Service objects in all collections

Clear all Service objects in all collections

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Service objects

List the Service objects

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Service objects

Clear the Service objects

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Service object by id

Get the Service object by id

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-id
    Required*
    string

    Service name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Service object by id

Update the Service object by id

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-id
    Required*
    string

    Service name

Request Body

Service

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Service object by id

Delete the Service object by id

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-id
    Required*
    string

    Service name

Response

Response Body

Service

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Service object by name and version

Get the Service object by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

  • service-version
    Required*
    string

    Service version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Service object by name and version

Update the Service object by name and version

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

  • service-version
    Required*
    string

    Service version name

Request Body

Service

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Service

Delete a Service

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

  • service-version
    Required*
    string

    Service version name

Response

Response Body

Service

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create the Global Policy Prehook object

Create the Global Policy Prehook object

POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPrehook

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy Prehook object

Get the Global Policy Prehook object

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy Prehook object

Update the Global Policy Prehook object

PUT /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPrehook

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Global Policy Prehook object

Delete the Global Policy Prehook object

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create the Global Policy Posthook object

Create the Global Policy Posthook object

POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPosthook

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy Posthook object

Get the Global Policy Posthook object

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy Posthook object

Update the Global Policy Posthook object

PUT /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPosthook

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Global Policy Posthook object

Delete the Global Policy Posthook object

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Analytics Service objects

List the Analytics Service objects

GET /spaces/{org}/{catalog}/{space}/analytics-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AnalyticsServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Analytics Service object by name or id

Get the Analytics Service object by name or id

GET /spaces/{org}/{catalog}/{space}/analytics-services/{analytics-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • analytics-service
    Required*
    string

    Analytics Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • query
    string

    Add query to request

Response

Response Body

AnalyticsService

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create an Analytics object

Create an Analytics object

POST /spaces/{org}/{catalog}/{space}/analytics-services/{analytics-service}/analytics

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • analytics-service
    Required*
    string

    Analytics Service name or id

Query Parameters

  • query
    string

    Add query to request

Request Body

object

Response

Response Body

object

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Global Policy object

Create a Global Policy object

POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicy

Response

Response Body

GlobalPolicy

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Global Policy objects in all collections

List all Global Policy objects in all collections

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

GlobalPolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Global Policy objects in all collections

Clear all Global Policy objects in all collections

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Global Policy objects

List the Global Policy objects

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

GlobalPolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Global Policy objects

Clear the Global Policy objects

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy object by id

Get the Global Policy object by id

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy object by id

Update the Global Policy object by id

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Request Body

GlobalPolicy

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Global Policy object by id

Delete the Global Policy object by id

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy object by name and version

Get the Global Policy object by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy object by name and version

Update the Global Policy object by name and version

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Request Body

GlobalPolicy

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Global Policy

Delete a Global Policy

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Response

Response Body

GlobalPolicy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy document

Get the Global Policy document

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-id
    Required*
    string

    Global Policy name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy document by name and version

Get the Global Policy document by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • global-policy-name
    Required*
    string

    Global Policy name

  • global-policy-version
    Required*
    string

    Global Policy version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Policy object

Create a Policy object

POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Form Parameters

  • policy
  • implementation

Response

Response Body

Policy

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Policy objects in all collections

List all Policy objects in all collections

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Policy objects in all collections

Clear all Policy objects in all collections

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Policy objects

List the Policy objects

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Policy objects

Clear the Policy objects

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy object by id

Get the Policy object by id

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Policy object by id

Update the Policy object by id

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Request Body

Policy

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Policy object by id

Delete the Policy object by id

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Response

Response Body

Policy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy object by name and version

Get the Policy object by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Policy object by name and version

Update the Policy object by name and version

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Request Body

Policy

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Policy

Delete a Policy

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Response

Response Body

Policy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy document

Get the Policy document

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy document by name and version

Get the Policy document by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy implementation document

Get the Policy implementation document

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}/implementation

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy implementation document by name and version

Get the Policy implementation document by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}/implementation

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Policy object

Create a Policy object

POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Form Parameters

  • policy
  • implementation

Response

Response Body

Policy

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Policy objects in all collections

List all Policy objects in all collections

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Policy objects in all collections

Clear all Policy objects in all collections

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Policy objects

List the Policy objects

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PolicyList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Policy objects

Clear the Policy objects

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy object by id

Get the Policy object by id

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Policy object by id

Update the Policy object by id

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Request Body

Policy

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Policy object by id

Delete the Policy object by id

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Response

Response Body

Policy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy object by name and version

Get the Policy object by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Policy object by name and version

Update the Policy object by name and version

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Request Body

Policy

Response

Response Body

Policy

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Policy

Delete a Policy

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Response

Response Body

Policy

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy document

Get the Policy document

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy document by name and version

Get the Policy document by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy implementation document

Get the Policy implementation document

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}/implementation

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-id
    Required*
    string

    Policy name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Policy implementation document by name and version

Get the Policy implementation document by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}/implementation

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • policy-name
    Required*
    string

    Policy name

  • policy-version
    Required*
    string

    Policy version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Extension object

Create a Extension object

POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

Extension

Response

Response Body

Extension

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Extension objects in all collections

List all Extension objects in all collections

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ExtensionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Extension objects in all collections

Clear all Extension objects in all collections

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Extension objects

List the Extension objects

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ExtensionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Extension objects

Clear the Extension objects

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension object by id

Get the Extension object by id

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Extension object by id

Update the Extension object by id

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Request Body

Extension

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Extension object by id

Delete the Extension object by id

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Response

Response Body

Extension

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension object by name and version

Get the Extension object by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Extension object by name and version

Update the Extension object by name and version

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Request Body

Extension

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Extension

Delete a Extension

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Response

Response Body

Extension

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension document

Get the Extension document

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Response

Response Body

ExtensionDocument

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension document by name and version

Get the Extension document by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Response

Response Body

ExtensionDocument

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Extension object

Create a Extension object

POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

Extension

Response

Response Body

Extension

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Extension objects in all collections

List all Extension objects in all collections

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ExtensionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Extension objects in all collections

Clear all Extension objects in all collections

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Extension objects

List the Extension objects

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ExtensionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Extension objects

Clear the Extension objects

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension object by id

Get the Extension object by id

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Extension object by id

Update the Extension object by id

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Request Body

Extension

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Extension object by id

Delete the Extension object by id

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Response

Response Body

Extension

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension object by name and version

Get the Extension object by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Extension object by name and version

Update the Extension object by name and version

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Request Body

Extension

Response

Response Body

Extension

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Extension

Delete a Extension

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Response

Response Body

Extension

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension document

Get the Extension document

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-id
    Required*
    string

    Extension name

Response

Response Body

ExtensionDocument

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Extension document by name and version

Get the Extension document by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • extension-name
    Required*
    string

    Extension name

  • extension-version
    Required*
    string

    Extension version name

Response

Response Body

ExtensionDocument

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Service object

Create a Service object

POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

Service

Response

Response Body

Service

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Service objects in all collections

List all Service objects in all collections

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Service objects in all collections

Clear all Service objects in all collections

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Service objects

List the Service objects

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Service objects

Clear the Service objects

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Service object by id

Get the Service object by id

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-id
    Required*
    string

    Service name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Service object by id

Update the Service object by id

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-id
    Required*
    string

    Service name

Request Body

Service

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Service object by id

Delete the Service object by id

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-id
    Required*
    string

    Service name

Response

Response Body

Service

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Service object by name and version

Get the Service object by name and version

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

  • service-version
    Required*
    string

    Service version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Service object by name and version

Update the Service object by name and version

PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

  • service-version
    Required*
    string

    Service version name

Request Body

Service

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Service

Delete a Service

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

  • service-version
    Required*
    string

    Service version name

Response

Response Body

Service

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Service object

Create a Service object

POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

Service

Response

Response Body

Service

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Service objects in all collections

List all Service objects in all collections

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Service objects in all collections

Clear all Service objects in all collections

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Service objects

List the Service objects

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Service objects

Clear the Service objects

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Service object by id

Get the Service object by id

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-id
    Required*
    string

    Service name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Service object by id

Update the Service object by id

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-id
    Required*
    string

    Service name

Request Body

Service

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Service object by id

Delete the Service object by id

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-id
    Required*
    string

    Service name

Response

Response Body

Service

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Service object by name and version

Get the Service object by name and version

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

  • service-version
    Required*
    string

    Service version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Service object by name and version

Update the Service object by name and version

PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

  • service-version
    Required*
    string

    Service version name

Request Body

Service

Response

Response Body

Service

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Service

Delete a Service

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • service-name
    Required*
    string

    Service name

  • service-version
    Required*
    string

    Service version name

Response

Response Body

Service

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create the Global Policy Prehook object

Create the Global Policy Prehook object

POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPrehook

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy Prehook object

Get the Global Policy Prehook object

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy Prehook object

Update the Global Policy Prehook object

PUT /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPrehook

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Global Policy Prehook object

Delete the Global Policy Prehook object

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create the Global Policy Prehook object

Create the Global Policy Prehook object

POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPrehook

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy Prehook object

Get the Global Policy Prehook object

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy Prehook object

Update the Global Policy Prehook object

PUT /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPrehook

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Global Policy Prehook object

Delete the Global Policy Prehook object

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Response

Response Body

GlobalPolicyPrehook

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create the Global Policy Posthook object

Create the Global Policy Posthook object

POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPosthook

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy Posthook object

Get the Global Policy Posthook object

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy Posthook object

Update the Global Policy Posthook object

PUT /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPosthook

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Global Policy Posthook object

Delete the Global Policy Posthook object

DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create the Global Policy Posthook object

Create the Global Policy Posthook object

POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPosthook

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Global Policy Posthook object

Get the Global Policy Posthook object

GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Global Policy Posthook object

Update the Global Policy Posthook object

PUT /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Request Body

GlobalPolicyPosthook

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Global Policy Posthook object

Delete the Global Policy Posthook object

DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Response

Response Body

GlobalPolicyPosthook

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Analytics Service objects

List the Analytics Service objects

GET /catalogs/{org}/{catalog}/analytics-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AnalyticsServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Analytics Service object by name or id

Get the Analytics Service object by name or id

GET /catalogs/{org}/{catalog}/analytics-services/{analytics-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • analytics-service
    Required*
    string

    Analytics Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • query
    string

    Add query to request

Response

Response Body

AnalyticsService

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create an Analytics object

Create an Analytics object

POST /catalogs/{org}/{catalog}/analytics-services/{analytics-service}/analytics

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • analytics-service
    Required*
    string

    Analytics Service name or id

Query Parameters

  • query
    string

    Add query to request

Request Body

object

Response

Response Body

object

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Analytics Service objects

List the Analytics Service objects

GET /spaces/{org}/{catalog}/{space}/analytics-services

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AnalyticsServiceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Analytics Service object by name or id

Get the Analytics Service object by name or id

GET /spaces/{org}/{catalog}/{space}/analytics-services/{analytics-service}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • analytics-service
    Required*
    string

    Analytics Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • query
    string

    Add query to request

Response

Response Body

AnalyticsService

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create an Analytics object

Create an Analytics object

POST /spaces/{org}/{catalog}/{space}/analytics-services/{analytics-service}/analytics

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • analytics-service
    Required*
    string

    Analytics Service name or id

Query Parameters

  • query
    string

    Add query to request

Request Body

object

Response

Response Body

object

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Space Setting object

Get the Space Setting object

GET /spaces/{org}/{catalog}/{space}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

SpaceSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Space Setting object

Update the Space Setting object

PUT /spaces/{org}/{catalog}/{space}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

SpaceSetting

Response

Response Body

SpaceSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Notification Template objects in all collections

List all Notification Template objects in all collections

GET /spaces/{org}/{catalog}/{space}/settings/notification-templates

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /spaces/{org}/{catalog}/{space}/settings/notification-templates/space

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /spaces/{org}/{catalog}/{space}/settings/notification-templates/space/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /spaces/{org}/{catalog}/{space}/settings/notification-templates/space/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Notification Template objects

List the Notification Template objects

GET /spaces/{org}/{catalog}/{space}/settings/notification-templates/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

NotificationTemplateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Notification Template object by name or id

Get the Notification Template object by name or id

GET /spaces/{org}/{catalog}/{space}/settings/notification-templates/consumer/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Notification Template object by name or id

Update the Notification Template object by name or id

PATCH /spaces/{org}/{catalog}/{space}/settings/notification-templates/consumer/{notification-template}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • notification-template
    Required*
    string

    Notification Template name or id

Request Body

NotificationTemplate

Response

Response Body

NotificationTemplate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Role Default objects in all collections

List all Role Default objects in all collections

GET /spaces/{org}/{catalog}/{space}/role-defaults

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleDefaultList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Role Default object

Create a Role Default object

POST /spaces/{org}/{catalog}/{space}/role-defaults/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

RoleDefault

Response

Response Body

RoleDefault

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role Default objects

List the Role Default objects

GET /spaces/{org}/{catalog}/{space}/role-defaults/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleDefaultList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Role Default objects

Clear the Role Default objects

DELETE /spaces/{org}/{catalog}/{space}/role-defaults/consumer

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role Default object by name or id

Get the Role Default object by name or id

GET /spaces/{org}/{catalog}/{space}/role-defaults/consumer/{role-default}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • role-default
    Required*
    string

    Role Default name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

RoleDefault

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role Default object by name or id

Update the Role Default object by name or id

PATCH /spaces/{org}/{catalog}/{space}/role-defaults/consumer/{role-default}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • role-default
    Required*
    string

    Role Default name or id

Request Body

RoleDefault

Response

Response Body

RoleDefault

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Role Default object by name or id

Delete the Role Default object by name or id

DELETE /spaces/{org}/{catalog}/{space}/role-defaults/consumer/{role-default}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • role-default
    Required*
    string

    Role Default name or id

Response

Response Body

RoleDefault

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Space object

Create a Space object

POST /catalogs/{org}/{catalog}/spaces

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

Space

Response

Response Body

Space

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Space objects

List the Space objects

GET /catalogs/{org}/{catalog}/spaces

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

SpaceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Space objects

Clear the Space objects

DELETE /catalogs/{org}/{catalog}/spaces

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Space object by name or id

Get the Space object by name or id

GET /spaces/{org}/{catalog}/{space}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Space

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Space object by name or id

Update the Space object by name or id

PATCH /spaces/{org}/{catalog}/{space}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

Space

Response

Response Body

Space

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Space object by name or id

Delete the Space object by name or id

DELETE /spaces/{org}/{catalog}/{space}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Response

Response Body

Space

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Transfer owner to an associate

Transfer owner to an associate

POST /spaces/{org}/{catalog}/{space}/transfer-owner

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

TransferOwner

Response

Response Body

Space

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Stage a draft product

Stage a draft product

POST /spaces/{org}/{catalog}/{space}/stage-draft-product

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Request Body

DraftProductPublish

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Publish a draft product

Publish a draft product

POST /spaces/{org}/{catalog}/{space}/publish-draft-product

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Request Body

DraftProductPublish

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Stage the product

Stage the product

POST /spaces/{org}/{catalog}/{space}/stage

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Form Parameters

  • product
    Required*
  • openapi
    Required*
  • gateway_service_urls
    string[]
  • wsdl
  • metadata

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Publish the product

Publish the product

POST /spaces/{org}/{catalog}/{space}/publish

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Form Parameters

  • product
    Required*
  • openapi
    Required*
  • gateway_service_urls
    string[]
  • wsdl
  • metadata

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Space Invitation object

Create a Space Invitation object

POST /catalogs/{org}/{catalog}/space-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Space Invitation objects

List the Space Invitation objects

GET /catalogs/{org}/{catalog}/space-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

InvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Space Invitation objects

Clear the Space Invitation objects

DELETE /catalogs/{org}/{catalog}/space-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Space Invitation object by name or id

Get the Space Invitation object by name or id

GET /catalogs/{org}/{catalog}/space-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Space Invitation object by name or id

Update the Space Invitation object by name or id

PATCH /catalogs/{org}/{catalog}/space-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Space Invitation object by name or id

Delete the Space Invitation object by name or id

DELETE /catalogs/{org}/{catalog}/space-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Response

Response Body

Invitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Space Invitation

Regenerate the Space Invitation

POST /catalogs/{org}/{catalog}/space-invitations/{invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Regenerate

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Register using the Space Invitation

Register using the Space Invitation

POST /catalogs/{org}/{catalog}/space-invitations/{invitation}/register

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

InvitationRegister

Response

Response Body

MemberRegisterResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Accept using the Space Invitation

Accept using the Space Invitation

POST /catalogs/{org}/{catalog}/space-invitations/{invitation}/accept

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

InvitationAccept

Response

Response Body

MemberAcceptResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role objects

List the Role objects

GET /spaces/{org}/{catalog}/{space}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role object by name or id

Get the Role object by name or id

GET /spaces/{org}/{catalog}/{space}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • role
    Required*
    string

    Role name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role object by name or id

Update the Role object by name or id

PATCH /spaces/{org}/{catalog}/{space}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • role
    Required*
    string

    Role name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member Invitation object

Create a Member Invitation object

POST /spaces/{org}/{catalog}/{space}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member Invitation objects

List the Member Invitation objects

GET /spaces/{org}/{catalog}/{space}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberInvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member Invitation objects

Clear the Member Invitation objects

DELETE /spaces/{org}/{catalog}/{space}/member-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member Invitation object by name or id

Get the Member Invitation object by name or id

GET /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member Invitation object by name or id

Update the Member Invitation object by name or id

PATCH /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member Invitation object by name or id

Delete the Member Invitation object by name or id

DELETE /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Response

Response Body

MemberInvitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Member Invitation

Regenerate the Member Invitation

POST /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

Regenerate

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Register using the Member Invitation

Register using the Member Invitation

POST /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}/register

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationRegister

Response

Response Body

MemberRegisterResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Accept using the Member Invitation

Accept using the Member Invitation

POST /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}/accept

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationAccept

Response

Response Body

MemberAcceptResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member object

Create a Member object

POST /spaces/{org}/{catalog}/{space}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member objects

List the Member objects

GET /spaces/{org}/{catalog}/{space}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member objects

Clear the Member objects

DELETE /spaces/{org}/{catalog}/{space}/members

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member object by name or id

Get the Member object by name or id

GET /spaces/{org}/{catalog}/{space}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member
    Required*
    string

    Member name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member object by name or id

Update the Member object by name or id

PATCH /spaces/{org}/{catalog}/{space}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member
    Required*
    string

    Member name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member object by name or id

Delete the Member object by name or id

DELETE /spaces/{org}/{catalog}/{space}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member
    Required*
    string

    Member name or id

Response

Response Body

Member

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Task objects

List the Task objects

GET /spaces/{org}/{catalog}/{space}/tasks

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

TaskList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Task object by name or id

Get the Task object by name or id

GET /spaces/{org}/{catalog}/{space}/tasks/{task}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • task
    Required*
    string

    Task name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Task

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Task object by name or id

Update the Task object by name or id

PATCH /spaces/{org}/{catalog}/{space}/tasks/{task}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • task
    Required*
    string

    Task name or id

Request Body

Task

Response

Response Body

Task

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Space object

Create a Space object

POST /catalogs/{org}/{catalog}/spaces

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

Space

Response

Response Body

Space

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Space objects

List the Space objects

GET /catalogs/{org}/{catalog}/spaces

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

SpaceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Space objects

Clear the Space objects

DELETE /catalogs/{org}/{catalog}/spaces

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Space object by name or id

Get the Space object by name or id

GET /spaces/{org}/{catalog}/{space}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Space

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Space object by name or id

Update the Space object by name or id

PATCH /spaces/{org}/{catalog}/{space}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

Space

Response

Response Body

Space

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Space object by name or id

Delete the Space object by name or id

DELETE /spaces/{org}/{catalog}/{space}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Response

Response Body

Space

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Transfer owner to an associate

Transfer owner to an associate

POST /spaces/{org}/{catalog}/{space}/transfer-owner

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

TransferOwner

Response

Response Body

Space

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Stage a draft product

Stage a draft product

POST /spaces/{org}/{catalog}/{space}/stage-draft-product

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Request Body

DraftProductPublish

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Publish a draft product

Publish a draft product

POST /spaces/{org}/{catalog}/{space}/publish-draft-product

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Request Body

DraftProductPublish

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Stage the product

Stage the product

POST /spaces/{org}/{catalog}/{space}/stage

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Form Parameters

  • product
    Required*
  • openapi
    Required*
  • gateway_service_urls
    string[]
  • wsdl
  • metadata

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Publish the product

Publish the product

POST /spaces/{org}/{catalog}/{space}/publish

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • gateway_services
    string

    The list of gateway service names to support partial publishing

Form Parameters

  • product
    Required*
  • openapi
    Required*
  • gateway_service_urls
    string[]
  • wsdl
  • metadata

Response

Response Body

Product

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Space Invitation object

Create a Space Invitation object

POST /catalogs/{org}/{catalog}/space-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Space Invitation objects

List the Space Invitation objects

GET /catalogs/{org}/{catalog}/space-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

InvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Space Invitation objects

Clear the Space Invitation objects

DELETE /catalogs/{org}/{catalog}/space-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Space Invitation object by name or id

Get the Space Invitation object by name or id

GET /catalogs/{org}/{catalog}/space-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Space Invitation object by name or id

Update the Space Invitation object by name or id

PATCH /catalogs/{org}/{catalog}/space-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Space Invitation object by name or id

Delete the Space Invitation object by name or id

DELETE /catalogs/{org}/{catalog}/space-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Response

Response Body

Invitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Space Invitation

Regenerate the Space Invitation

POST /catalogs/{org}/{catalog}/space-invitations/{invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Regenerate

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Register using the Space Invitation

Register using the Space Invitation

POST /catalogs/{org}/{catalog}/space-invitations/{invitation}/register

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

InvitationRegister

Response

Response Body

MemberRegisterResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Accept using the Space Invitation

Accept using the Space Invitation

POST /catalogs/{org}/{catalog}/space-invitations/{invitation}/accept

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

InvitationAccept

Response

Response Body

MemberAcceptResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role objects

List the Role objects

GET /spaces/{org}/{catalog}/{space}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role object by name or id

Get the Role object by name or id

GET /spaces/{org}/{catalog}/{space}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • role
    Required*
    string

    Role name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role object by name or id

Update the Role object by name or id

PATCH /spaces/{org}/{catalog}/{space}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • role
    Required*
    string

    Role name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member Invitation object

Create a Member Invitation object

POST /spaces/{org}/{catalog}/{space}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member Invitation objects

List the Member Invitation objects

GET /spaces/{org}/{catalog}/{space}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberInvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member Invitation objects

Clear the Member Invitation objects

DELETE /spaces/{org}/{catalog}/{space}/member-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member Invitation object by name or id

Get the Member Invitation object by name or id

GET /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member Invitation object by name or id

Update the Member Invitation object by name or id

PATCH /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member Invitation object by name or id

Delete the Member Invitation object by name or id

DELETE /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Response

Response Body

MemberInvitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Member Invitation

Regenerate the Member Invitation

POST /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

Regenerate

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Register using the Member Invitation

Register using the Member Invitation

POST /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}/register

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationRegister

Response

Response Body

MemberRegisterResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Accept using the Member Invitation

Accept using the Member Invitation

POST /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}/accept

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationAccept

Response

Response Body

MemberAcceptResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member object

Create a Member object

POST /spaces/{org}/{catalog}/{space}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member objects

List the Member objects

GET /spaces/{org}/{catalog}/{space}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member objects

Clear the Member objects

DELETE /spaces/{org}/{catalog}/{space}/members

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member object by name or id

Get the Member object by name or id

GET /spaces/{org}/{catalog}/{space}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member
    Required*
    string

    Member name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member object by name or id

Update the Member object by name or id

PATCH /spaces/{org}/{catalog}/{space}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member
    Required*
    string

    Member name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member object by name or id

Delete the Member object by name or id

DELETE /spaces/{org}/{catalog}/{space}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • member
    Required*
    string

    Member name or id

Response

Response Body

Member

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Task objects

List the Task objects

GET /spaces/{org}/{catalog}/{space}/tasks

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

TaskList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Task object by name or id

Get the Task object by name or id

GET /spaces/{org}/{catalog}/{space}/tasks/{task}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • task
    Required*
    string

    Task name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Task

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Task object by name or id

Update the Task object by name or id

PATCH /spaces/{org}/{catalog}/{space}/tasks/{task}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • task
    Required*
    string

    Task name or id

Request Body

Task

Response

Response Body

Task

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application objects

List the Application objects

GET /catalogs/{org}/{catalog}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AppList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application objects

List the Application objects

GET /spaces/{org}/{catalog}/{space}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AppList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Consumer Organization Setting object

Get the Consumer Organization Setting object

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConsumerOrgSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Consumer Organization Setting object

Update the Consumer Organization Setting object

PUT /consumer-orgs/{org}/{catalog}/{consumer-org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

ConsumerOrgSetting

Response

Response Body

ConsumerOrgSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Consumer Organization Setting object

Delete the Consumer Organization Setting object

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Response

Response Body

ConsumerOrgSetting

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Consumer Organization Setting object

Get the Consumer Organization Setting object

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConsumerOrgSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Consumer Organization Setting object

Update the Consumer Organization Setting object

PUT /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

ConsumerOrgSetting

Response

Response Body

ConsumerOrgSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Consumer Organization Setting object

Delete the Consumer Organization Setting object

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Response

Response Body

ConsumerOrgSetting

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Consumer Organization Invitation object

Create a Consumer Organization Invitation object

POST /catalogs/{org}/{catalog}/consumer-org-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Consumer Organization Invitation objects

List the Consumer Organization Invitation objects

GET /catalogs/{org}/{catalog}/consumer-org-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

InvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Consumer Organization Invitation objects

Clear the Consumer Organization Invitation objects

DELETE /catalogs/{org}/{catalog}/consumer-org-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Consumer Organization Invitation object by name or id

Get the Consumer Organization Invitation object by name or id

GET /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Consumer Organization Invitation object by name or id

Update the Consumer Organization Invitation object by name or id

PATCH /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Consumer Organization Invitation object by name or id

Delete the Consumer Organization Invitation object by name or id

DELETE /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Response

Response Body

Invitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Consumer Organization Invitation

Regenerate the Consumer Organization Invitation

POST /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Regenerate

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Consumer Organization Invitation object

Create a Consumer Organization Invitation object

POST /spaces/{org}/{catalog}/{space}/consumer-org-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Consumer Organization Invitation objects

List the Consumer Organization Invitation objects

GET /spaces/{org}/{catalog}/{space}/consumer-org-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

InvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Consumer Organization Invitation objects

Clear the Consumer Organization Invitation objects

DELETE /spaces/{org}/{catalog}/{space}/consumer-org-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Consumer Organization Invitation object by name or id

Get the Consumer Organization Invitation object by name or id

GET /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Consumer Organization Invitation object by name or id

Update the Consumer Organization Invitation object by name or id

PATCH /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Consumer Organization Invitation object by name or id

Delete the Consumer Organization Invitation object by name or id

DELETE /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Response

Response Body

Invitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Consumer Organization Invitation

Regenerate the Consumer Organization Invitation

POST /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Regenerate

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Consumer Organization object

Create a Consumer Organization object

POST /catalogs/{org}/{catalog}/consumer-orgs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

ConsumerOrg

Response

Response Body

ConsumerOrg

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Consumer Organization objects

List the Consumer Organization objects

GET /catalogs/{org}/{catalog}/consumer-orgs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConsumerOrgList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Consumer Organization objects

Clear the Consumer Organization objects

DELETE /catalogs/{org}/{catalog}/consumer-orgs

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Consumer Organization object by name or id

Get the Consumer Organization object by name or id

GET /consumer-orgs/{org}/{catalog}/{consumer-org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Consumer Organization object by name or id

Update the Consumer Organization object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

ConsumerOrg

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Consumer Organization object by name or id

Delete the Consumer Organization object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Transfer owner to an associate

Transfer owner to an associate

POST /consumer-orgs/{org}/{catalog}/{consumer-org}/transfer-owner

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

TransferOwner

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Consumer Organization object

Create a Consumer Organization object

POST /spaces/{org}/{catalog}/{space}/consumer-orgs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

ConsumerOrg

Response

Response Body

ConsumerOrg

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Consumer Organization objects

List the Consumer Organization objects

GET /spaces/{org}/{catalog}/{space}/consumer-orgs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConsumerOrgList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Consumer Organization objects

Clear the Consumer Organization objects

DELETE /spaces/{org}/{catalog}/{space}/consumer-orgs

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Consumer Organization object by name or id

Get the Consumer Organization object by name or id

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Consumer Organization object by name or id

Update the Consumer Organization object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

ConsumerOrg

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Consumer Organization object by name or id

Delete the Consumer Organization object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Transfer owner to an associate

Transfer owner to an associate

POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/transfer-owner

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

TransferOwner

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Group object

Create a Group object

POST /catalogs/{org}/{catalog}/consumer-groups

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

Group

Response

Response Body

Group

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Group objects

List the Group objects

GET /catalogs/{org}/{catalog}/consumer-groups

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

GroupList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Group objects

Clear the Group objects

DELETE /catalogs/{org}/{catalog}/consumer-groups

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Group object by name or id

Get the Group object by name or id

GET /catalogs/{org}/{catalog}/consumer-groups/{group}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • group
    Required*
    string

    Group name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Group

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Group object by name or id

Update the Group object by name or id

PATCH /catalogs/{org}/{catalog}/consumer-groups/{group}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • group
    Required*
    string

    Group name or id

Request Body

Group

Response

Response Body

Group

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Group object by name or id

Delete the Group object by name or id

DELETE /catalogs/{org}/{catalog}/consumer-groups/{group}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • group
    Required*
    string

    Group name or id

Response

Response Body

Group

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Payment Method object

Create a Payment Method object

POST /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

PaymentMethod

Response

Response Body

PaymentMethod

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Payment Method objects

List the Payment Method objects

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PaymentMethodList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Payment Method object by name or id

Get the Payment Method object by name or id

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods/{payment-method}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • payment-method
    Required*
    string

    Payment Method name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

PaymentMethod

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Payment Method object by name or id

Update the Payment Method object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods/{payment-method}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • payment-method
    Required*
    string

    Payment Method name or id

Request Body

PaymentMethod

Response

Response Body

PaymentMethod

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Role object

Create a Role object

POST /consumer-orgs/{org}/{catalog}/{consumer-org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role objects

List the Role objects

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Role objects

Clear the Role objects

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/roles

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role object by name or id

Get the Role object by name or id

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • role
    Required*
    string

    Role name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role object by name or id

Update the Role object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • role
    Required*
    string

    Role name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Role object by name or id

Delete the Role object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • role
    Required*
    string

    Role name or id

Response

Response Body

Role

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Role object

Create a Role object

POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role objects

List the Role objects

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Role objects

Clear the Role objects

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role object by name or id

Get the Role object by name or id

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • role
    Required*
    string

    Role name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role object by name or id

Update the Role object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • role
    Required*
    string

    Role name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Role object by name or id

Delete the Role object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • role
    Required*
    string

    Role name or id

Response

Response Body

Role

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Associate objects

List the Associate objects

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/associates

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AssociateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Associate object by name or id

Get the Associate object by name or id

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/associates/{associate}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • associate
    Required*
    string

    Associate name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Associate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Associate objects

List the Associate objects

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/associates

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AssociateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Associate object by name or id

Get the Associate object by name or id

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/associates/{associate}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • associate
    Required*
    string

    Associate name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Associate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member Invitation object

Create a Member Invitation object

POST /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member Invitation objects

List the Member Invitation objects

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberInvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member Invitation objects

Clear the Member Invitation objects

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member Invitation object by name or id

Get the Member Invitation object by name or id

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member Invitation object by name or id

Update the Member Invitation object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member Invitation object by name or id

Delete the Member Invitation object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Response

Response Body

MemberInvitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Member Invitation

Regenerate the Member Invitation

POST /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

Regenerate

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member Invitation object

Create a Member Invitation object

POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member Invitation objects

List the Member Invitation objects

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberInvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member Invitation objects

Clear the Member Invitation objects

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member Invitation object by name or id

Get the Member Invitation object by name or id

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member Invitation object by name or id

Update the Member Invitation object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member Invitation object by name or id

Delete the Member Invitation object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Response

Response Body

MemberInvitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Member Invitation

Regenerate the Member Invitation

POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

Regenerate

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member object

Create a Member object

POST /consumer-orgs/{org}/{catalog}/{consumer-org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member objects

List the Member objects

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member objects

Clear the Member objects

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/members

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member object by name or id

Get the Member object by name or id

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member
    Required*
    string

    Member name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member object by name or id

Update the Member object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member
    Required*
    string

    Member name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member object by name or id

Delete the Member object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member
    Required*
    string

    Member name or id

Response

Response Body

Member

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member object

Create a Member object

POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member objects

List the Member objects

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member objects

Clear the Member objects

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member object by name or id

Get the Member object by name or id

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member
    Required*
    string

    Member name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member object by name or id

Update the Member object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member
    Required*
    string

    Member name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member object by name or id

Delete the Member object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member
    Required*
    string

    Member name or id

Response

Response Body

Member

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Application object

Create a Application object

POST /consumer-orgs/{org}/{catalog}/{consumer-org}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

App

Response

Response Body

App

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application objects

List the Application objects

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AppList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Application objects

Clear the Application objects

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/apps

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Application object by name or id

Get the Application object by name or id

GET /apps/{org}/{catalog}/{consumer-org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

App

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Application object by name or id

Update the Application object by name or id

PATCH /apps/{org}/{catalog}/{consumer-org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

App

Response

Response Body

App

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Application object by name or id

Delete the Application object by name or id

DELETE /apps/{org}/{catalog}/{consumer-org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Response

Response Body

App

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Application object

Create a Application object

POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

App

Response

Response Body

App

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application objects

List the Application objects

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AppList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Application objects

Clear the Application objects

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/apps

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Application object by name or id

Get the Application object by name or id

GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

App

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Application object by name or id

Update the Application object by name or id

PATCH /apps/{org}/{catalog}/{space}/{consumer-org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

App

Response

Response Body

App

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Application object by name or id

Delete the Application object by name or id

DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Response

Response Body

App

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Application Credential object

Create a Application Credential object

POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application Credential objects

List the Application Credential objects

GET /apps/{org}/{catalog}/{consumer-org}/{app}/credentials

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

CredentialList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Application Credential objects

Clear the Application Credential objects

DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/credentials

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Application Credential object by name or id

Get the Application Credential object by name or id

GET /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Application Credential object by name or id

Update the Application Credential object by name or id

PATCH /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Application Credential object by name or id

Delete the Application Credential object by name or id

DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset the client id and client secret

Reset the client id and client secret

POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/reset

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset the client secret

Reset the client secret

POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/reset-client-secret

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Verify the client secret

Verify the client secret

POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/verify-client-secret

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Application Credential object

Create a Application Credential object

POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application Credential objects

List the Application Credential objects

GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

CredentialList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Application Credential objects

Clear the Application Credential objects

DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Application Credential object by name or id

Get the Application Credential object by name or id

GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Application Credential object by name or id

Update the Application Credential object by name or id

PATCH /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Application Credential object by name or id

Delete the Application Credential object by name or id

DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset the client id and client secret

Reset the client id and client secret

POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/reset

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset the client secret

Reset the client secret

POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/reset-client-secret

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Verify the client secret

Verify the client secret

POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/verify-client-secret

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Subscription object

Create a Subscription object

POST /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

Subscription

Response

Response Body

Subscription

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Subscription objects

List the Subscription objects

GET /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

SubscriptionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Subscription objects

Clear the Subscription objects

DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Subscription object by name or id

Get the Subscription object by name or id

GET /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Subscription

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Subscription object by name or id

Update the Subscription object by name or id

PATCH /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Request Body

Subscription

Response

Response Body

Subscription

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Subscription object by name or id

Delete the Subscription object by name or id

DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Response

Response Body

Subscription

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Subscription object

Create a Subscription object

POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

Subscription

Response

Response Body

Subscription

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Subscription objects

List the Subscription objects

GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

SubscriptionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Subscription objects

Clear the Subscription objects

DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Subscription object by name or id

Get the Subscription object by name or id

GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Subscription

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Subscription object by name or id

Update the Subscription object by name or id

PATCH /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Request Body

Subscription

Response

Response Body

Subscription

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Subscription object by name or id

Delete the Subscription object by name or id

DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Response

Response Body

Subscription

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application objects

List the Application objects

GET /catalogs/{org}/{catalog}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AppList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application objects

List the Application objects

GET /spaces/{org}/{catalog}/{space}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AppList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Consumer Organization Setting object

Get the Consumer Organization Setting object

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConsumerOrgSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Consumer Organization Setting object

Update the Consumer Organization Setting object

PUT /consumer-orgs/{org}/{catalog}/{consumer-org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

ConsumerOrgSetting

Response

Response Body

ConsumerOrgSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Consumer Organization Setting object

Delete the Consumer Organization Setting object

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Response

Response Body

ConsumerOrgSetting

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Consumer Organization Setting object

Get the Consumer Organization Setting object

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConsumerOrgSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Consumer Organization Setting object

Update the Consumer Organization Setting object

PUT /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

ConsumerOrgSetting

Response

Response Body

ConsumerOrgSetting

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Consumer Organization Setting object

Delete the Consumer Organization Setting object

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Response

Response Body

ConsumerOrgSetting

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Activation objects

List the Activation objects

GET /catalogs/{org}/{catalog}/activations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ActivationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Activation objects

Clear the Activation objects

DELETE /catalogs/{org}/{catalog}/activations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Activation object by name or id

Get the Activation object by name or id

GET /activations/{org}/{catalog}/{activation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • activation
    Required*
    string

    Activation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Activation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Activation object by name or id

Delete the Activation object by name or id

DELETE /activations/{org}/{catalog}/{activation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • activation
    Required*
    string

    Activation name or id

Response

Response Body

Activation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Consumer Organization Invitation object

Create a Consumer Organization Invitation object

POST /catalogs/{org}/{catalog}/consumer-org-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Consumer Organization Invitation objects

List the Consumer Organization Invitation objects

GET /catalogs/{org}/{catalog}/consumer-org-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

InvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Consumer Organization Invitation objects

Clear the Consumer Organization Invitation objects

DELETE /catalogs/{org}/{catalog}/consumer-org-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Consumer Organization Invitation object by name or id

Get the Consumer Organization Invitation object by name or id

GET /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Consumer Organization Invitation object by name or id

Update the Consumer Organization Invitation object by name or id

PATCH /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Consumer Organization Invitation object by name or id

Delete the Consumer Organization Invitation object by name or id

DELETE /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Response

Response Body

Invitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Consumer Organization Invitation

Regenerate the Consumer Organization Invitation

POST /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Regenerate

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Consumer Organization Invitation object

Create a Consumer Organization Invitation object

POST /spaces/{org}/{catalog}/{space}/consumer-org-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Consumer Organization Invitation objects

List the Consumer Organization Invitation objects

GET /spaces/{org}/{catalog}/{space}/consumer-org-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

InvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Consumer Organization Invitation objects

Clear the Consumer Organization Invitation objects

DELETE /spaces/{org}/{catalog}/{space}/consumer-org-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Consumer Organization Invitation object by name or id

Get the Consumer Organization Invitation object by name or id

GET /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Consumer Organization Invitation object by name or id

Update the Consumer Organization Invitation object by name or id

PATCH /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Invitation

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Consumer Organization Invitation object by name or id

Delete the Consumer Organization Invitation object by name or id

DELETE /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Response

Response Body

Invitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Consumer Organization Invitation

Regenerate the Consumer Organization Invitation

POST /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • invitation
    Required*
    string

    Consumer Organization Invitation name or id

Request Body

Regenerate

Response

Response Body

Invitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Consumer Organization object

Create a Consumer Organization object

POST /catalogs/{org}/{catalog}/consumer-orgs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

ConsumerOrg

Response

Response Body

ConsumerOrg

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Consumer Organization objects

List the Consumer Organization objects

GET /catalogs/{org}/{catalog}/consumer-orgs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConsumerOrgList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Consumer Organization objects

Clear the Consumer Organization objects

DELETE /catalogs/{org}/{catalog}/consumer-orgs

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Consumer Organization object by name or id

Get the Consumer Organization object by name or id

GET /consumer-orgs/{org}/{catalog}/{consumer-org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Consumer Organization object by name or id

Update the Consumer Organization object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

ConsumerOrg

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Consumer Organization object by name or id

Delete the Consumer Organization object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Transfer owner to an associate

Transfer owner to an associate

POST /consumer-orgs/{org}/{catalog}/{consumer-org}/transfer-owner

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

TransferOwner

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Consumer Organization object

Create a Consumer Organization object

POST /spaces/{org}/{catalog}/{space}/consumer-orgs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Request Body

ConsumerOrg

Response

Response Body

ConsumerOrg

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Consumer Organization objects

List the Consumer Organization objects

GET /spaces/{org}/{catalog}/{space}/consumer-orgs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ConsumerOrgList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Consumer Organization objects

Clear the Consumer Organization objects

DELETE /spaces/{org}/{catalog}/{space}/consumer-orgs

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Consumer Organization object by name or id

Get the Consumer Organization object by name or id

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Consumer Organization object by name or id

Update the Consumer Organization object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

ConsumerOrg

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Consumer Organization object by name or id

Delete the Consumer Organization object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Transfer owner to an associate

Transfer owner to an associate

POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/transfer-owner

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

TransferOwner

Response

Response Body

ConsumerOrg

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Group object

Create a Group object

POST /catalogs/{org}/{catalog}/consumer-groups

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Request Body

Group

Response

Response Body

Group

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Group objects

List the Group objects

GET /catalogs/{org}/{catalog}/consumer-groups

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

GroupList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Group objects

Clear the Group objects

DELETE /catalogs/{org}/{catalog}/consumer-groups

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Group object by name or id

Get the Group object by name or id

GET /catalogs/{org}/{catalog}/consumer-groups/{group}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • group
    Required*
    string

    Group name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Group

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Group object by name or id

Update the Group object by name or id

PATCH /catalogs/{org}/{catalog}/consumer-groups/{group}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • group
    Required*
    string

    Group name or id

Request Body

Group

Response

Response Body

Group

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Group object by name or id

Delete the Group object by name or id

DELETE /catalogs/{org}/{catalog}/consumer-groups/{group}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • group
    Required*
    string

    Group name or id

Response

Response Body

Group

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Payment Method object

Create a Payment Method object

POST /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

PaymentMethod

Response

Response Body

PaymentMethod

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Payment Method objects

List the Payment Method objects

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PaymentMethodList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Payment Method object by name or id

Get the Payment Method object by name or id

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods/{payment-method}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • payment-method
    Required*
    string

    Payment Method name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

PaymentMethod

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Payment Method object by name or id

Update the Payment Method object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods/{payment-method}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • payment-method
    Required*
    string

    Payment Method name or id

Request Body

PaymentMethod

Response

Response Body

PaymentMethod

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Role object

Create a Role object

POST /consumer-orgs/{org}/{catalog}/{consumer-org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role objects

List the Role objects

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Role objects

Clear the Role objects

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/roles

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role object by name or id

Get the Role object by name or id

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • role
    Required*
    string

    Role name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role object by name or id

Update the Role object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • role
    Required*
    string

    Role name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Role object by name or id

Delete the Role object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • role
    Required*
    string

    Role name or id

Response

Response Body

Role

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Role object

Create a Role object

POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role objects

List the Role objects

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Role objects

Clear the Role objects

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role object by name or id

Get the Role object by name or id

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • role
    Required*
    string

    Role name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role object by name or id

Update the Role object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • role
    Required*
    string

    Role name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Role object by name or id

Delete the Role object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • role
    Required*
    string

    Role name or id

Response

Response Body

Role

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Associate objects

List the Associate objects

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/associates

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AssociateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Associate object by name or id

Get the Associate object by name or id

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/associates/{associate}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • associate
    Required*
    string

    Associate name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Associate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Associate objects

List the Associate objects

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/associates

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AssociateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Associate object by name or id

Get the Associate object by name or id

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/associates/{associate}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • associate
    Required*
    string

    Associate name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Associate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member Invitation object

Create a Member Invitation object

POST /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member Invitation objects

List the Member Invitation objects

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberInvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member Invitation objects

Clear the Member Invitation objects

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member Invitation object by name or id

Get the Member Invitation object by name or id

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member Invitation object by name or id

Update the Member Invitation object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member Invitation object by name or id

Delete the Member Invitation object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Response

Response Body

MemberInvitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Member Invitation

Regenerate the Member Invitation

POST /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

Regenerate

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member Invitation object

Create a Member Invitation object

POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member Invitation objects

List the Member Invitation objects

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberInvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member Invitation objects

Clear the Member Invitation objects

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member Invitation object by name or id

Get the Member Invitation object by name or id

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member Invitation object by name or id

Update the Member Invitation object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member Invitation object by name or id

Delete the Member Invitation object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Response

Response Body

MemberInvitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Member Invitation

Regenerate the Member Invitation

POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

Regenerate

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member object

Create a Member object

POST /consumer-orgs/{org}/{catalog}/{consumer-org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member objects

List the Member objects

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member objects

Clear the Member objects

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/members

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member object by name or id

Get the Member object by name or id

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member
    Required*
    string

    Member name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member object by name or id

Update the Member object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member
    Required*
    string

    Member name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member object by name or id

Delete the Member object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member
    Required*
    string

    Member name or id

Response

Response Body

Member

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member object

Create a Member object

POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member objects

List the Member objects

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member objects

Clear the Member objects

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member object by name or id

Get the Member object by name or id

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member
    Required*
    string

    Member name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member object by name or id

Update the Member object by name or id

PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member
    Required*
    string

    Member name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member object by name or id

Delete the Member object by name or id

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • member
    Required*
    string

    Member name or id

Response

Response Body

Member

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Application object

Create a Application object

POST /consumer-orgs/{org}/{catalog}/{consumer-org}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

App

Response

Response Body

App

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application objects

List the Application objects

GET /consumer-orgs/{org}/{catalog}/{consumer-org}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AppList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Application objects

Clear the Application objects

DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/apps

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Application object by name or id

Get the Application object by name or id

GET /apps/{org}/{catalog}/{consumer-org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

App

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Application object by name or id

Update the Application object by name or id

PATCH /apps/{org}/{catalog}/{consumer-org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

App

Response

Response Body

App

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Application object by name or id

Delete the Application object by name or id

DELETE /apps/{org}/{catalog}/{consumer-org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Response

Response Body

App

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Application object

Create a Application object

POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Request Body

App

Response

Response Body

App

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application objects

List the Application objects

GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AppList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Application objects

Clear the Application objects

DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/apps

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Application object by name or id

Get the Application object by name or id

GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

App

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Application object by name or id

Update the Application object by name or id

PATCH /apps/{org}/{catalog}/{space}/{consumer-org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

App

Response

Response Body

App

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Application object by name or id

Delete the Application object by name or id

DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Response

Response Body

App

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Application Credential object

Create a Application Credential object

POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application Credential objects

List the Application Credential objects

GET /apps/{org}/{catalog}/{consumer-org}/{app}/credentials

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

CredentialList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Application Credential objects

Clear the Application Credential objects

DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/credentials

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Application Credential object by name or id

Get the Application Credential object by name or id

GET /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Application Credential object by name or id

Update the Application Credential object by name or id

PATCH /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Application Credential object by name or id

Delete the Application Credential object by name or id

DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset the client id and client secret

Reset the client id and client secret

POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/reset

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset the client secret

Reset the client secret

POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/reset-client-secret

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Verify the client secret

Verify the client secret

POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/verify-client-secret

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Application Credential object

Create a Application Credential object

POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application Credential objects

List the Application Credential objects

GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

CredentialList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Application Credential objects

Clear the Application Credential objects

DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Application Credential object by name or id

Get the Application Credential object by name or id

GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Application Credential object by name or id

Update the Application Credential object by name or id

PATCH /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Application Credential object by name or id

Delete the Application Credential object by name or id

DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset the client id and client secret

Reset the client id and client secret

POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/reset

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset the client secret

Reset the client secret

POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/reset-client-secret

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Verify the client secret

Verify the client secret

POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/verify-client-secret

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Subscription object

Create a Subscription object

POST /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

Subscription

Response

Response Body

Subscription

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Subscription objects

List the Subscription objects

GET /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

SubscriptionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Subscription objects

Clear the Subscription objects

DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Subscription object by name or id

Get the Subscription object by name or id

GET /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Subscription

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Subscription object by name or id

Update the Subscription object by name or id

PATCH /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Request Body

Subscription

Response

Response Body

Subscription

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Subscription object by name or id

Delete the Subscription object by name or id

DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Response

Response Body

Subscription

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Subscription object

Create a Subscription object

POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

Subscription

Response

Response Body

Subscription

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Subscription objects

List the Subscription objects

GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

SubscriptionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Subscription objects

Clear the Subscription objects

DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Subscription object by name or id

Get the Subscription object by name or id

GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Subscription

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Subscription object by name or id

Update the Subscription object by name or id

PATCH /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Request Body

Subscription

Response

Response Body

Subscription

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Subscription object by name or id

Delete the Subscription object by name or id

DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • consumer-org
    Required*
    string

    Consumer Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Response

Response Body

Subscription

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Draft objects

List the Draft objects

GET /orgs/{org}/drafts

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

DraftList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Draft objects

Clear the Draft objects

DELETE /orgs/{org}/drafts

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Introspect the WSDL

Introspect the WSDL

POST /orgs/{org}/drafts/introspect-wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • wsdl_services
    string

    A comma delimited list of WSDL services to introspect

Form Parameters

  • wsdl

Response

Response Body

WsdlServices

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Draft Product object

Create a Draft Product object

POST /orgs/{org}/drafts/draft-products

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

DraftProduct

Response

Response Body

DraftProduct

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Draft Product objects in all collections

List all Draft Product objects in all collections

GET /orgs/{org}/drafts/draft-products

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

DraftProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Draft Product objects in all collections

Clear all Draft Product objects in all collections

DELETE /orgs/{org}/drafts/draft-products

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Draft Product objects

List the Draft Product objects

GET /orgs/{org}/drafts/draft-products/{draft-product-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-name
    Required*
    string

    Draft Product name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

DraftProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Draft Product objects

Clear the Draft Product objects

DELETE /orgs/{org}/drafts/draft-products/{draft-product-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-name
    Required*
    string

    Draft Product name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft Product object by id

Get the Draft Product object by id

GET /orgs/{org}/drafts/draft-products/{draft-product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-id
    Required*
    string

    Draft Product name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

DraftProduct

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Draft Product object by id

Update the Draft Product object by id

PATCH /orgs/{org}/drafts/draft-products/{draft-product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-id
    Required*
    string

    Draft Product name

Request Body

DraftProduct

Response

Response Body

DraftProduct

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Draft Product object by id

Delete the Draft Product object by id

DELETE /orgs/{org}/drafts/draft-products/{draft-product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-id
    Required*
    string

    Draft Product name

Response

Response Body

DraftProduct

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft Product object by name and version

Get the Draft Product object by name and version

GET /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-name
    Required*
    string

    Draft Product name

  • draft-product-version
    Required*
    string

    Draft Product version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

DraftProduct

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Draft Product object by name and version

Update the Draft Product object by name and version

PATCH /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-name
    Required*
    string

    Draft Product name

  • draft-product-version
    Required*
    string

    Draft Product version name

Request Body

DraftProduct

Response

Response Body

DraftProduct

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Draft Product

Delete a Draft Product

DELETE /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-name
    Required*
    string

    Draft Product name

  • draft-product-version
    Required*
    string

    Draft Product version name

Response

Response Body

DraftProduct

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Validate the draft product

Validate the draft product

POST /orgs/{org}/drafts/draft-products/{draft-product-id}/validate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-id
    Required*
    string

    Draft Product name

Response

Response Body

ValidationResults

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Validate the draft product

Validate the draft product

POST /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}/validate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-name
    Required*
    string

    Draft Product name

  • draft-product-version
    Required*
    string

    Draft Product version name

Response

Response Body

ValidationResults

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft Product document

Get the Draft Product document

GET /orgs/{org}/drafts/draft-products/{draft-product-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-id
    Required*
    string

    Draft Product name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft Product document by name and version

Get the Draft Product document by name and version

GET /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-name
    Required*
    string

    Draft Product name

  • draft-product-version
    Required*
    string

    Draft Product version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Draft API object

Create a Draft API object

POST /orgs/{org}/drafts/draft-apis

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • api_type
    string

    The type of api (rest, graphql, wsdl_to_rest, or wsdl)

  • gateway_type
    string

    The type of the gateway (datapower-gateway, datapower-api-gateway)

  • assembly_type
    string

    The type of the assembly to generate (rest_to_proxy)

  • wsdl_service
    string

    Name of WSDL service to create the OpenAPI definition from

  • disable_ws_security
    boolean

    Disable generation of WS-Security definitions in api

Request Body

DraftAPI

Response

Response Body

DraftAPI

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Draft API objects in all collections

List all Draft API objects in all collections

GET /orgs/{org}/drafts/draft-apis

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

DraftAPIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Draft API objects in all collections

Clear all Draft API objects in all collections

DELETE /orgs/{org}/drafts/draft-apis

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Draft API objects

List the Draft API objects

GET /orgs/{org}/drafts/draft-apis/{draft-api-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

DraftAPIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Draft API objects

Clear the Draft API objects

DELETE /orgs/{org}/drafts/draft-apis/{draft-api-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft API object by id

Get the Draft API object by id

GET /orgs/{org}/drafts/draft-apis/{draft-api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-id
    Required*
    string

    Draft API name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

DraftAPI

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Draft API object by id

Update the Draft API object by id

PATCH /orgs/{org}/drafts/draft-apis/{draft-api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-id
    Required*
    string

    Draft API name

Query Parameters

  • api_type
    string

    The type of api (rest, graphql, wsdl_to_rest, or wsdl)

  • wsdl_service
    string

    Name of WSDL service to create the OpenAPI definition from

  • disable_ws_security
    boolean

    Disable generation of WS-Security definitions in api

Request Body

DraftAPI

Response

Response Body

DraftAPI

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Draft API object by id

Delete the Draft API object by id

DELETE /orgs/{org}/drafts/draft-apis/{draft-api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-id
    Required*
    string

    Draft API name

Response

Response Body

DraftAPI

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft API object by name and version

Get the Draft API object by name and version

GET /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

  • draft-api-version
    Required*
    string

    Draft API version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

DraftAPI

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Draft API object by name and version

Update the Draft API object by name and version

PATCH /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

  • draft-api-version
    Required*
    string

    Draft API version name

Query Parameters

  • api_type
    string

    The type of api (rest, graphql, wsdl_to_rest, or wsdl)

  • wsdl_service
    string

    Name of WSDL service to create the OpenAPI definition from

  • disable_ws_security
    boolean

    Disable generation of WS-Security definitions in api

Request Body

DraftAPI

Response

Response Body

DraftAPI

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Draft API

Delete a Draft API

DELETE /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

  • draft-api-version
    Required*
    string

    Draft API version name

Response

Response Body

DraftAPI

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Validate the draft api

Validate the draft api

POST /orgs/{org}/drafts/draft-apis/{draft-api-id}/validate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-id
    Required*
    string

    Draft API name

Response

Response Body

ValidationResults

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Validate the draft api

Validate the draft api

POST /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}/validate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

  • draft-api-version
    Required*
    string

    Draft API version name

Response

Response Body

ValidationResults

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Add a target service

Add a target service

POST /orgs/{org}/drafts/draft-apis/{draft-api-id}/add-target-service

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-id
    Required*
    string

    Draft API name

Query Parameters

  • wsdl_service
    string

    Name of WSDL service to create the OpenAPI definition from

  • disable_ws_security
    boolean

    Disable generation of WS-Security definitions in api

Form Parameters

  • wsdl

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Add a target service

Add a target service

POST /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}/add-target-service

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

  • draft-api-version
    Required*
    string

    Draft API version name

Query Parameters

  • wsdl_service
    string

    Name of WSDL service to create the OpenAPI definition from

  • disable_ws_security
    boolean

    Disable generation of WS-Security definitions in api

Form Parameters

  • wsdl

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft API document

Get the Draft API document

GET /orgs/{org}/drafts/draft-apis/{draft-api-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-id
    Required*
    string

    Draft API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft API document by name and version

Get the Draft API document by name and version

GET /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

  • draft-api-version
    Required*
    string

    Draft API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft API wsdl document

Get the Draft API wsdl document

GET /orgs/{org}/drafts/draft-apis/{draft-api-id}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-id
    Required*
    string

    Draft API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft API wsdl document by name and version

Get the Draft API wsdl document by name and version

GET /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

  • draft-api-version
    Required*
    string

    Draft API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Draft objects

List the Draft objects

GET /orgs/{org}/drafts

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

DraftList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Draft objects

Clear the Draft objects

DELETE /orgs/{org}/drafts

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Introspect the WSDL

Introspect the WSDL

POST /orgs/{org}/drafts/introspect-wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • wsdl_services
    string

    A comma delimited list of WSDL services to introspect

Form Parameters

  • wsdl

Response

Response Body

WsdlServices

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Draft Product object

Create a Draft Product object

POST /orgs/{org}/drafts/draft-products

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

DraftProduct

Response

Response Body

DraftProduct

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Draft Product objects in all collections

List all Draft Product objects in all collections

GET /orgs/{org}/drafts/draft-products

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

DraftProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Draft Product objects in all collections

Clear all Draft Product objects in all collections

DELETE /orgs/{org}/drafts/draft-products

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Draft Product objects

List the Draft Product objects

GET /orgs/{org}/drafts/draft-products/{draft-product-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-name
    Required*
    string

    Draft Product name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

DraftProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Draft Product objects

Clear the Draft Product objects

DELETE /orgs/{org}/drafts/draft-products/{draft-product-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-name
    Required*
    string

    Draft Product name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft Product object by id

Get the Draft Product object by id

GET /orgs/{org}/drafts/draft-products/{draft-product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-id
    Required*
    string

    Draft Product name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

DraftProduct

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Draft Product object by id

Update the Draft Product object by id

PATCH /orgs/{org}/drafts/draft-products/{draft-product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-id
    Required*
    string

    Draft Product name

Request Body

DraftProduct

Response

Response Body

DraftProduct

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Draft Product object by id

Delete the Draft Product object by id

DELETE /orgs/{org}/drafts/draft-products/{draft-product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-id
    Required*
    string

    Draft Product name

Response

Response Body

DraftProduct

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft Product object by name and version

Get the Draft Product object by name and version

GET /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-name
    Required*
    string

    Draft Product name

  • draft-product-version
    Required*
    string

    Draft Product version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

DraftProduct

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Draft Product object by name and version

Update the Draft Product object by name and version

PATCH /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-name
    Required*
    string

    Draft Product name

  • draft-product-version
    Required*
    string

    Draft Product version name

Request Body

DraftProduct

Response

Response Body

DraftProduct

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Draft Product

Delete a Draft Product

DELETE /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-name
    Required*
    string

    Draft Product name

  • draft-product-version
    Required*
    string

    Draft Product version name

Response

Response Body

DraftProduct

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Validate the draft product

Validate the draft product

POST /orgs/{org}/drafts/draft-products/{draft-product-id}/validate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-id
    Required*
    string

    Draft Product name

Response

Response Body

ValidationResults

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Validate the draft product

Validate the draft product

POST /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}/validate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-name
    Required*
    string

    Draft Product name

  • draft-product-version
    Required*
    string

    Draft Product version name

Response

Response Body

ValidationResults

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft Product document

Get the Draft Product document

GET /orgs/{org}/drafts/draft-products/{draft-product-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-id
    Required*
    string

    Draft Product name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft Product document by name and version

Get the Draft Product document by name and version

GET /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-product-name
    Required*
    string

    Draft Product name

  • draft-product-version
    Required*
    string

    Draft Product version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Draft API object

Create a Draft API object

POST /orgs/{org}/drafts/draft-apis

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • api_type
    string

    The type of api (rest, graphql, wsdl_to_rest, or wsdl)

  • gateway_type
    string

    The type of the gateway (datapower-gateway, datapower-api-gateway)

  • assembly_type
    string

    The type of the assembly to generate (rest_to_proxy)

  • wsdl_service
    string

    Name of WSDL service to create the OpenAPI definition from

  • disable_ws_security
    boolean

    Disable generation of WS-Security definitions in api

Request Body

DraftAPI

Response

Response Body

DraftAPI

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Draft API objects in all collections

List all Draft API objects in all collections

GET /orgs/{org}/drafts/draft-apis

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

DraftAPIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Draft API objects in all collections

Clear all Draft API objects in all collections

DELETE /orgs/{org}/drafts/draft-apis

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Draft API objects

List the Draft API objects

GET /orgs/{org}/drafts/draft-apis/{draft-api-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

DraftAPIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Draft API objects

Clear the Draft API objects

DELETE /orgs/{org}/drafts/draft-apis/{draft-api-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft API object by id

Get the Draft API object by id

GET /orgs/{org}/drafts/draft-apis/{draft-api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-id
    Required*
    string

    Draft API name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

DraftAPI

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Draft API object by id

Update the Draft API object by id

PATCH /orgs/{org}/drafts/draft-apis/{draft-api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-id
    Required*
    string

    Draft API name

Query Parameters

  • api_type
    string

    The type of api (rest, graphql, wsdl_to_rest, or wsdl)

  • wsdl_service
    string

    Name of WSDL service to create the OpenAPI definition from

  • disable_ws_security
    boolean

    Disable generation of WS-Security definitions in api

Request Body

DraftAPI

Response

Response Body

DraftAPI

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Draft API object by id

Delete the Draft API object by id

DELETE /orgs/{org}/drafts/draft-apis/{draft-api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-id
    Required*
    string

    Draft API name

Response

Response Body

DraftAPI

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft API object by name and version

Get the Draft API object by name and version

GET /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

  • draft-api-version
    Required*
    string

    Draft API version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

DraftAPI

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Draft API object by name and version

Update the Draft API object by name and version

PATCH /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml,multipart/form-data]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

  • draft-api-version
    Required*
    string

    Draft API version name

Query Parameters

  • api_type
    string

    The type of api (rest, graphql, wsdl_to_rest, or wsdl)

  • wsdl_service
    string

    Name of WSDL service to create the OpenAPI definition from

  • disable_ws_security
    boolean

    Disable generation of WS-Security definitions in api

Request Body

DraftAPI

Response

Response Body

DraftAPI

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Draft API

Delete a Draft API

DELETE /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

  • draft-api-version
    Required*
    string

    Draft API version name

Response

Response Body

DraftAPI

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Validate the draft api

Validate the draft api

POST /orgs/{org}/drafts/draft-apis/{draft-api-id}/validate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-id
    Required*
    string

    Draft API name

Response

Response Body

ValidationResults

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Validate the draft api

Validate the draft api

POST /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}/validate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

  • draft-api-version
    Required*
    string

    Draft API version name

Response

Response Body

ValidationResults

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Add a target service

Add a target service

POST /orgs/{org}/drafts/draft-apis/{draft-api-id}/add-target-service

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-id
    Required*
    string

    Draft API name

Query Parameters

  • wsdl_service
    string

    Name of WSDL service to create the OpenAPI definition from

  • disable_ws_security
    boolean

    Disable generation of WS-Security definitions in api

Form Parameters

  • wsdl

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Add a target service

Add a target service

POST /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}/add-target-service

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

  • draft-api-version
    Required*
    string

    Draft API version name

Query Parameters

  • wsdl_service
    string

    Name of WSDL service to create the OpenAPI definition from

  • disable_ws_security
    boolean

    Disable generation of WS-Security definitions in api

Form Parameters

  • wsdl

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft API document

Get the Draft API document

GET /orgs/{org}/drafts/draft-apis/{draft-api-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-id
    Required*
    string

    Draft API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft API document by name and version

Get the Draft API document by name and version

GET /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

  • draft-api-version
    Required*
    string

    Draft API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft API wsdl document

Get the Draft API wsdl document

GET /orgs/{org}/drafts/draft-apis/{draft-api-id}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-id
    Required*
    string

    Draft API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Draft API wsdl document by name and version

Get the Draft API wsdl document by name and version

GET /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • draft-api-name
    Required*
    string

    Draft API name

  • draft-api-version
    Required*
    string

    Draft API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Product objects in all collections

List all Product objects in all collections

GET /catalogs/{org}/{catalog}/products

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Product objects in all collections

Clear all Product objects in all collections

DELETE /catalogs/{org}/{catalog}/products

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Product objects

List the Product objects

GET /catalogs/{org}/{catalog}/products/{product-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Product objects

Clear the Product objects

DELETE /catalogs/{org}/{catalog}/products/{product-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by id

Get the Product object by id

GET /catalogs/{org}/{catalog}/products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Product object by id

Update the Product object by id

PATCH /catalogs/{org}/{catalog}/products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Request Body

Product

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Product object by id

Delete the Product object by id

DELETE /catalogs/{org}/{catalog}/products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Response

Response Body

Product

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by name and version

Get the Product object by name and version

GET /catalogs/{org}/{catalog}/products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Product object by name and version

Update the Product object by name and version

PATCH /catalogs/{org}/{catalog}/products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

Product

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Product

Delete a Product

DELETE /catalogs/{org}/{catalog}/products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

Product

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Hot replace a product

Hot replace a product

POST /catalogs/{org}/{catalog}/products/{product-id}/replace

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Supersede a product

Supersede a product

POST /catalogs/{org}/{catalog}/products/{product-id}/supersede

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Set the migration target of a product

Set the migration target of a product

POST /catalogs/{org}/{catalog}/products/{product-id}/set-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate list of subscriptions between products

Migrate list of subscriptions between products

POST /catalogs/{org}/{catalog}/products/{product-id}/migrate-subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Request Body

MigrateSubscriptionSubset

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate all subscriptions to their migration targets

Migrate all subscriptions to their migration targets

POST /catalogs/{org}/{catalog}/products/{product-id}/execute-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Hot replace the product

Hot replace the product

POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/replace

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Supersede a product

Supersede a product

POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/supersede

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Set the migration target

Set the migration target

POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/set-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate list of subscriptions between products

Migrate list of subscriptions between products

POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/migrate-subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

MigrateSubscriptionSubset

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate all subscriptions to their migration targets

Migrate all subscriptions to their migration targets

POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/execute-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document

Get the Product document

GET /catalogs/{org}/{catalog}/products/{product-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document by name and version

Get the Product document by name and version

GET /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all API objects in all collections

List all API objects in all collections

GET /catalogs/{org}/{catalog}/apis

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the API objects

List the API objects

GET /catalogs/{org}/{catalog}/apis/{api-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-name
    Required*
    string

    API name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by id

Get the API object by id

GET /catalogs/{org}/{catalog}/apis/{api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-id
    Required*
    string

    API name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the API object by id

Update the API object by id

PATCH /catalogs/{org}/{catalog}/apis/{api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-id
    Required*
    string

    API name

Request Body

API

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by name and version

Get the API object by name and version

GET /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the API object by name and version

Update the API object by name and version

PATCH /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Request Body

API

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document

Get the API document

GET /catalogs/{org}/{catalog}/apis/{api-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-id
    Required*
    string

    API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document by name and version

Get the API document by name and version

GET /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document

Get the API wsdl document

GET /catalogs/{org}/{catalog}/apis/{api-id}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-id
    Required*
    string

    API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document by name and version

Get the API wsdl document by name and version

GET /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Product objects in all collections

List all Product objects in all collections

GET /spaces/{org}/{catalog}/{space}/products

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Product objects in all collections

Clear all Product objects in all collections

DELETE /spaces/{org}/{catalog}/{space}/products

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Product objects

List the Product objects

GET /spaces/{org}/{catalog}/{space}/products/{product-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Product objects

Clear the Product objects

DELETE /spaces/{org}/{catalog}/{space}/products/{product-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by id

Get the Product object by id

GET /spaces/{org}/{catalog}/{space}/products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Product object by id

Update the Product object by id

PATCH /spaces/{org}/{catalog}/{space}/products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Request Body

Product

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Product object by id

Delete the Product object by id

DELETE /spaces/{org}/{catalog}/{space}/products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Response

Response Body

Product

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by name and version

Get the Product object by name and version

GET /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Product object by name and version

Update the Product object by name and version

PATCH /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

Product

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Product

Delete a Product

DELETE /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

Product

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Hot replace a product

Hot replace a product

POST /spaces/{org}/{catalog}/{space}/products/{product-id}/replace

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Supersede a product

Supersede a product

POST /spaces/{org}/{catalog}/{space}/products/{product-id}/supersede

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Set the migration target of a product

Set the migration target of a product

POST /spaces/{org}/{catalog}/{space}/products/{product-id}/set-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate list of subscriptions between products

Migrate list of subscriptions between products

POST /spaces/{org}/{catalog}/{space}/products/{product-id}/migrate-subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Request Body

MigrateSubscriptionSubset

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate all subscriptions to their migration targets

Migrate all subscriptions to their migration targets

POST /spaces/{org}/{catalog}/{space}/products/{product-id}/execute-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Hot replace the product

Hot replace the product

POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/replace

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Supersede a product

Supersede a product

POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/supersede

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Set the migration target

Set the migration target

POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/set-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate list of subscriptions between products

Migrate list of subscriptions between products

POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/migrate-subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

MigrateSubscriptionSubset

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate all subscriptions to their migration targets

Migrate all subscriptions to their migration targets

POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/execute-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document

Get the Product document

GET /spaces/{org}/{catalog}/{space}/products/{product-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document by name and version

Get the Product document by name and version

GET /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all API objects in all collections

List all API objects in all collections

GET /spaces/{org}/{catalog}/{space}/apis

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the API objects

List the API objects

GET /spaces/{org}/{catalog}/{space}/apis/{api-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-name
    Required*
    string

    API name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by id

Get the API object by id

GET /spaces/{org}/{catalog}/{space}/apis/{api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-id
    Required*
    string

    API name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the API object by id

Update the API object by id

PATCH /spaces/{org}/{catalog}/{space}/apis/{api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-id
    Required*
    string

    API name

Request Body

API

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by name and version

Get the API object by name and version

GET /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the API object by name and version

Update the API object by name and version

PATCH /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Request Body

API

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document

Get the API document

GET /spaces/{org}/{catalog}/{space}/apis/{api-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-id
    Required*
    string

    API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document by name and version

Get the API document by name and version

GET /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document

Get the API wsdl document

GET /spaces/{org}/{catalog}/{space}/apis/{api-id}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-id
    Required*
    string

    API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document by name and version

Get the API wsdl document by name and version

GET /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Product objects in all collections

List all Product objects in all collections

GET /catalogs/{org}/{catalog}/products

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Product objects in all collections

Clear all Product objects in all collections

DELETE /catalogs/{org}/{catalog}/products

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Product objects

List the Product objects

GET /catalogs/{org}/{catalog}/products/{product-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Product objects

Clear the Product objects

DELETE /catalogs/{org}/{catalog}/products/{product-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by id

Get the Product object by id

GET /catalogs/{org}/{catalog}/products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Product object by id

Update the Product object by id

PATCH /catalogs/{org}/{catalog}/products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Request Body

Product

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Product object by id

Delete the Product object by id

DELETE /catalogs/{org}/{catalog}/products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Response

Response Body

Product

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by name and version

Get the Product object by name and version

GET /catalogs/{org}/{catalog}/products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Product object by name and version

Update the Product object by name and version

PATCH /catalogs/{org}/{catalog}/products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

Product

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Product

Delete a Product

DELETE /catalogs/{org}/{catalog}/products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

Product

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Hot replace a product

Hot replace a product

POST /catalogs/{org}/{catalog}/products/{product-id}/replace

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Supersede a product

Supersede a product

POST /catalogs/{org}/{catalog}/products/{product-id}/supersede

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Set the migration target of a product

Set the migration target of a product

POST /catalogs/{org}/{catalog}/products/{product-id}/set-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate list of subscriptions between products

Migrate list of subscriptions between products

POST /catalogs/{org}/{catalog}/products/{product-id}/migrate-subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Request Body

MigrateSubscriptionSubset

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate all subscriptions to their migration targets

Migrate all subscriptions to their migration targets

POST /catalogs/{org}/{catalog}/products/{product-id}/execute-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Hot replace the product

Hot replace the product

POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/replace

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Supersede a product

Supersede a product

POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/supersede

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Set the migration target

Set the migration target

POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/set-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate list of subscriptions between products

Migrate list of subscriptions between products

POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/migrate-subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

MigrateSubscriptionSubset

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate all subscriptions to their migration targets

Migrate all subscriptions to their migration targets

POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/execute-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document

Get the Product document

GET /catalogs/{org}/{catalog}/products/{product-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-id
    Required*
    string

    Product name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document by name and version

Get the Product document by name and version

GET /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all API objects in all collections

List all API objects in all collections

GET /catalogs/{org}/{catalog}/apis

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the API objects

List the API objects

GET /catalogs/{org}/{catalog}/apis/{api-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-name
    Required*
    string

    API name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by id

Get the API object by id

GET /catalogs/{org}/{catalog}/apis/{api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-id
    Required*
    string

    API name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the API object by id

Update the API object by id

PATCH /catalogs/{org}/{catalog}/apis/{api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-id
    Required*
    string

    API name

Request Body

API

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by name and version

Get the API object by name and version

GET /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the API object by name and version

Update the API object by name and version

PATCH /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Request Body

API

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document

Get the API document

GET /catalogs/{org}/{catalog}/apis/{api-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-id
    Required*
    string

    API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document by name and version

Get the API document by name and version

GET /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document

Get the API wsdl document

GET /catalogs/{org}/{catalog}/apis/{api-id}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-id
    Required*
    string

    API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document by name and version

Get the API wsdl document by name and version

GET /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Product objects in all collections

List all Product objects in all collections

GET /spaces/{org}/{catalog}/{space}/products

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear all Product objects in all collections

Clear all Product objects in all collections

DELETE /spaces/{org}/{catalog}/{space}/products

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Product objects

List the Product objects

GET /spaces/{org}/{catalog}/{space}/products/{product-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Product objects

Clear the Product objects

DELETE /spaces/{org}/{catalog}/{space}/products/{product-name}

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

Query Parameters

  • confirm
    Required*
    string

    Confirmation for critical updates

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by id

Get the Product object by id

GET /spaces/{org}/{catalog}/{space}/products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Product object by id

Update the Product object by id

PATCH /spaces/{org}/{catalog}/{space}/products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Request Body

Product

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Product object by id

Delete the Product object by id

DELETE /spaces/{org}/{catalog}/{space}/products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Response

Response Body

Product

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by name and version

Get the Product object by name and version

GET /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Product object by name and version

Update the Product object by name and version

PATCH /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

Product

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete a Product

Delete a Product

DELETE /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

Product

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Hot replace a product

Hot replace a product

POST /spaces/{org}/{catalog}/{space}/products/{product-id}/replace

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Supersede a product

Supersede a product

POST /spaces/{org}/{catalog}/{space}/products/{product-id}/supersede

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Set the migration target of a product

Set the migration target of a product

POST /spaces/{org}/{catalog}/{space}/products/{product-id}/set-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate list of subscriptions between products

Migrate list of subscriptions between products

POST /spaces/{org}/{catalog}/{space}/products/{product-id}/migrate-subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Request Body

MigrateSubscriptionSubset

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate all subscriptions to their migration targets

Migrate all subscriptions to their migration targets

POST /spaces/{org}/{catalog}/{space}/products/{product-id}/execute-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Hot replace the product

Hot replace the product

POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/replace

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Supersede a product

Supersede a product

POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/supersede

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Set the migration target

Set the migration target

POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/set-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

ProductPlanMapping

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate list of subscriptions between products

Migrate list of subscriptions between products

POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/migrate-subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Request Body

MigrateSubscriptionSubset

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Migrate all subscriptions to their migration targets

Migrate all subscriptions to their migration targets

POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/execute-migration-target

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document

Get the Product document

GET /spaces/{org}/{catalog}/{space}/products/{product-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-id
    Required*
    string

    Product name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document by name and version

Get the Product document by name and version

GET /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all API objects in all collections

List all API objects in all collections

GET /spaces/{org}/{catalog}/{space}/apis

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the API objects

List the API objects

GET /spaces/{org}/{catalog}/{space}/apis/{api-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-name
    Required*
    string

    API name

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by id

Get the API object by id

GET /spaces/{org}/{catalog}/{space}/apis/{api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-id
    Required*
    string

    API name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the API object by id

Update the API object by id

PATCH /spaces/{org}/{catalog}/{space}/apis/{api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-id
    Required*
    string

    API name

Request Body

API

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by name and version

Get the API object by name and version

GET /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the API object by name and version

Update the API object by name and version

PATCH /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Request Body

API

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document

Get the API document

GET /spaces/{org}/{catalog}/{space}/apis/{api-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-id
    Required*
    string

    API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document by name and version

Get the API document by name and version

GET /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document

Get the API wsdl document

GET /spaces/{org}/{catalog}/{space}/apis/{api-id}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-id
    Required*
    string

    API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document by name and version

Get the API wsdl document by name and version

GET /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • space
    Required*
    string

    Space name or id

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Me object

Get the Me object

GET /me

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • context
    string

    user's login context admin/manager

Response

Response Body

Me

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Me object

Update the Me object

PUT /me

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

Me

Response

Response Body

Me

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Me object

Delete the Me object

DELETE /me

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Response

Response Body

Me

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Change my password

Change my password

POST /me/change-password

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

ChangePassword

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset password

Reset password

POST /me/reset-password

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

ResetPassword

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Sign out

Sign out

POST /me/sign-out

Request

No Request Parameters

This method does not accept any request parameters.

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the My Permission objects

List the My Permission objects

GET /permissions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MyPermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the My Task objects

List the My Task objects

GET /tasks

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MyTaskList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Originated Task objects

List the Originated Task objects

GET /originated-tasks

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

OriginatedTaskList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the My Organization objects

List the My Organization objects

GET /orgs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

OrgList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the My Catalog objects

List the My Catalog objects

GET /catalogs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

CatalogList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the My Space objects

List the My Space objects

GET /spaces

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

SpaceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Me object

Get the Me object

GET /me

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • context
    string

    user's login context admin/manager

Response

Response Body

Me

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Me object

Update the Me object

PUT /me

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

Me

Response

Response Body

Me

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Me object

Delete the Me object

DELETE /me

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Response

Response Body

Me

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Change my password

Change my password

POST /me/change-password

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

ChangePassword

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset password

Reset password

POST /me/reset-password

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

ResetPassword

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Sign out

Sign out

POST /me/sign-out

Request

No Request Parameters

This method does not accept any request parameters.

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the My Permission objects

List the My Permission objects

GET /permissions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MyPermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the My Task objects

List the My Task objects

GET /tasks

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MyTaskList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Originated Task objects

List the Originated Task objects

GET /originated-tasks

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

OriginatedTaskList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the My Organization objects

List the My Organization objects

GET /orgs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

OrgList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the My Catalog objects

List the My Catalog objects

GET /catalogs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

CatalogList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the My Space objects

List the My Space objects

GET /spaces

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

SpaceList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Webhook objects

List the Webhook objects

GET /catalogs/{org}/{catalog}/webhooks

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

WebhookList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Webhook object by name or id

Get the Webhook object by name or id

GET /catalogs/{org}/{catalog}/webhooks/{webhook}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • webhook
    Required*
    string

    Webhook name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Webhook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Webhook object by name or id

Update the Webhook object by name or id

PATCH /catalogs/{org}/{catalog}/webhooks/{webhook}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • webhook
    Required*
    string

    Webhook name or id

Request Body

Webhook

Response

Response Body

Webhook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Primary Event objects

List the Primary Event objects

GET /catalogs/{org}/{catalog}/primary-events

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

  • state
    string

    State for a webhook event in subscriber queue

Response

Response Body

PrimaryEventList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Primary Event object by name or id

Get the Primary Event object by name or id

GET /catalogs/{org}/{catalog}/primary-events/{primary-event}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • primary-event
    Required*
    string

    Primary Event name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

PrimaryEvent

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Primary Event objects

List the Primary Event objects

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/primary-events

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

  • state
    string

    State for a webhook event in subscriber queue

Response

Response Body

PrimaryEventList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Primary Event object by name or id

Get the Primary Event object by name or id

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/primary-events/{primary-event}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • primary-event
    Required*
    string

    Primary Event name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

PrimaryEvent

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Subscriber Event objects

List the Subscriber Event objects

GET /catalogs/{org}/{catalog}/webhooks/{webhook}/subscriber-events

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • webhook
    Required*
    string

    Webhook name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

  • state
    string

    State for a webhook event in subscriber queue

Response

Response Body

SubscriberEventList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Subscriber Event object by name or id

Get the Subscriber Event object by name or id

GET /catalogs/{org}/{catalog}/webhooks/{webhook}/subscriber-events/{subscriber-event}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • webhook
    Required*
    string

    Webhook name or id

  • subscriber-event
    Required*
    string

    Subscriber Event name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

SubscriberEvent

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Webhook objects

List the Webhook objects

GET /catalogs/{org}/{catalog}/webhooks

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

WebhookList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Webhook object by name or id

Get the Webhook object by name or id

GET /catalogs/{org}/{catalog}/webhooks/{webhook}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • webhook
    Required*
    string

    Webhook name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

Webhook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Webhook object by name or id

Update the Webhook object by name or id

PATCH /catalogs/{org}/{catalog}/webhooks/{webhook}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • webhook
    Required*
    string

    Webhook name or id

Request Body

Webhook

Response

Response Body

Webhook

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Primary Event objects

List the Primary Event objects

GET /catalogs/{org}/{catalog}/primary-events

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

  • state
    string

    State for a webhook event in subscriber queue

Response

Response Body

PrimaryEventList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Primary Event object by name or id

Get the Primary Event object by name or id

GET /catalogs/{org}/{catalog}/primary-events/{primary-event}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • primary-event
    Required*
    string

    Primary Event name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

PrimaryEvent

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Primary Event objects

List the Primary Event objects

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/primary-events

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

  • state
    string

    State for a webhook event in subscriber queue

Response

Response Body

PrimaryEventList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Primary Event object by name or id

Get the Primary Event object by name or id

GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/primary-events/{primary-event}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • configured-gateway-service
    Required*
    string

    Configured Gateway Service name or id

  • primary-event
    Required*
    string

    Primary Event name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

PrimaryEvent

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Subscriber Event objects

List the Subscriber Event objects

GET /catalogs/{org}/{catalog}/webhooks/{webhook}/subscriber-events

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • webhook
    Required*
    string

    Webhook name or id

Query Parameters

  • fields
    string

    List of field names to return

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

  • state
    string

    State for a webhook event in subscriber queue

Response

Response Body

SubscriberEventList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Subscriber Event object by name or id

Get the Subscriber Event object by name or id

GET /catalogs/{org}/{catalog}/webhooks/{webhook}/subscriber-events/{subscriber-event}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • catalog
    Required*
    string

    Catalog name or id

  • webhook
    Required*
    string

    Webhook name or id

  • subscriber-event
    Required*
    string

    Subscriber Event name or id

Query Parameters

  • fields
    string

    List of field names to return

Response

Response Body

SubscriberEvent

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

id=curlclassName=tab-item-selected
Privacy statement