Get Instance Options

Use this API to get instance options.

API

/selfservice/v1/customers/{custId}/products/bounce/instances/{instanceName}/services

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can access this information only for instances that belong to your customer.
  • You can use Bounce Metadata API only if customer has opted-in for Bounce functionality.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/selfservice/v1/

Dependency

Functionality

  • This API exposes a list of services affected during bounce for a specific customer instance.
  • name value is the key.
  • label is a description which is used for displays.
  • {custId} and {instanceName} can be retrieved from the dependency mentioned.

Verb

GET

Parameters

Name Type Description Mandatory
custId Path parameter Customer identifier Yes
instanceName Path parameter Instance name Yes

Sample response

[
  {
    "name": "All",
    "label": "All (Apps and DB)"
  },
  {
    "name": "Apps",
    "label": "All Apps"
  },
  {
    "name": "Components",
    "label": "Apps Components"
  },
  {
    "name": "AllwithVM",
    "label": "All (Apps & DB) with VM"
  },
  {
    "name": "AppswithVM",
    "label": "All Apps with VM"
  }
]