Get Bounce Options for an Instance

Use this API to get bounce options for an instance.

API

/selfservice/v1/customers/{supportIdentifier}/{serviceType}/products/bounce/instances/{instanceId}/options

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can get bounce options for your customer services and instances only.
  • You can use Bounce 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 allows you to get bounce options for an instance.

Verb

GET

Parameters

Name Type Description Mandatory
supportIdentifier Path parameter Customer Support Identifier (CSI) Yes
serviceType Path parameter Service type (For example, EBSO, EBSZ, or EBSI) Yes
instanceId Path parameter Target name or instance name Yes

Sample response

{
  "hosts": [
    {
      "name": "adc42setest034.oracleoutsourcing.com",
      "options": [
        {
          "label": "OPMN services",
          "name": "OPMN",
          "value": false
        },
        {
          "label": "Apache",
          "name": "APACHE",
          "value": false
        },
        {
          "label": "Concurrent Manager",
          "name": "CONCURRENT_MANAGER",
          "value": false
        },
        {
          "label": "Workflow Mailer",
          "name": "WORKFLOW_MAILER",
          "value": false
        }
      ],
      "tier": "MT"
    },
    {
      "name": "adc42setest034.oracleoutsourcing.com",
      "options": [
        {
          "label": "Database",
          "name": "DATABASE",
          "value": false
        },
        {
          "label": "Database Listener",
          "name": "DB_LISTENER",
          "value": false
        }
      ],
      "tier": "DB"
    }
  ],
  "options": [
    {
      "label": "Clear Apache Cache",
      "name": "bounceAddOnCACHE",
      "value": false
    }
  ],
  "specialInstructionsExist": false
}