Oracle Cloud Infrastructure Documentation

Create Execution

Use this API to create a configuration execution.

API

/selfservice/v1/customers/{supportIdentifier}/{serviceType}/products/config/instances/{instanceId}/executions

Scope and AuthZ

  • You must have mcs:oci:api:PrivilegedUser scope to access this API.
  • You can create executions only for your customer instance.
  • You can use Configuration execution API only if your customer has opted-in for Configuration 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 create a configuration execution for a customer instance.
  • Request field that requires explanation:
    • primaryContact is the contact to be used while creating the ticket. primaryContact must be the valid contact for Customer Support Identifier (CSI).
  • Response field that requires explanation:
    • id is the unique identifier for the execution.

Verb

POST

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 Instance name or target name on which patches have to be applied. Yes

Sample request

{
  "summary": "Apply Config Changes",
  "duration": {
    "unit": "hours",
    "value": 4
  },
  "bounce": true,
  "config": {
    "type": "Trace & Debug",
    "activity": {
      "name": "FRD Enable/Disable",
      "type": "Enable",
      "parameters": [
        {
          "name": "UserName",
          "value": "oracle"
        },
        {
          "name": "Auto_Disable_Interval",
          "value": "2"
        }
      ]
    }
  },
  "ticketingDetails": {
    "primaryContact": "<email ID>",
    "customerNote": "Action Plan",
  }
}

Sample response

{
  "id": "3-7JZXAMZ",
  "rfcNumber": "3-7JZXAMZ"
}