Jump to

• Request
• Response
• Examples

Approve or reject a deployment request

put

/apiplatform/management/v1/apis/{apiId}/deployments/{depId}/state

Approves or rejects the {depId} deployment request in REQUESTING state for the {apiId} API. If rejecting a deployment request, you can optionally describe the reason in the deploymentComments attribute.

Users accessing this resource must be assigned the Gateway Manager role and must be issued the Manage Gateway grant for the gateway the API is deployed to.

Request

Supported Media Types

• application/json

Path Parameters

• apiId: string
  A unique ID referencing a specific API.
• depId: string
  A unique ID referencing a specific deployment.

Body ()

Root Schema : UpdateDeploymentStateRequest

Type: object

Show Source

• deploymentComments(optional): string
  Comments regarding the deployment's state.
• deploymentState: string
  The deployment's state. Valid values are REQUESTING, APPROVED, and REJECTED.

{
    "type":"object",
    "required":[
        "deploymentState"
    ],
    "properties":{
        "deploymentState":{
            "type":"string",
            "description":"The deployment's state. Valid values are <code>REQUESTING</code>, <code>APPROVED</code>, and <code>REJECTED</code>."
        },
        "deploymentComments":{
            "type":"string",
            "description":"Comments regarding the deployment's state."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The deployment's state was updated.

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to approve or reject the deployment request for the API by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X PUT 
-H "Authorization: Bearer access_token"
-H "Content-Type:application/json"
-d @deployment.json
https://example.com/apiplatform/management/v1/apis/{apiId}/deployments/{depId}/state

• {apiId} is the unique Id for an API. To retrieve available API Ids, see Get APIs.

• {depId} is the unique ID for a deployment. To retrieve available deployment IDs, see Get API deployments.

Example of Request Body

The following shows an example of the request body, included with the request above in a file named deployment.json.

{
"deploymentState":"APPROVED"
"deploymentComments": "Deployment approved"
}

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Server: Oracle-Traffic-Director/12.2.1.0.0
Date:  Wed, 22 Mar 2017 09:11:10 GMT
X-oracle-dms-ecid:  49d14691-2176-4c99-aed3-38438604f528-00001e79
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Back to Top