Jump to

• Request
• Response
• Examples

Deploy or request deployment of an API

post

/apiplatform/management/v1/gateways/{gwId}/deployments

Creates a new deployment request for the {gwId} gateway.

Users requesting this resource must be assigned the API Manager, or Gateway Manager role and must be issued the Gateway Manager, Deploy to Gateway, or Request Deployment to Gateway grant for the specified gateway. For a new deployment, the user must also be issued the Deploy API grant for the API they are deploying.

Request

Supported Media Types

• application/json

Path Parameters

• gwId: string
  A unique ID referencing a specific gateway.

Body ()

Root Schema : CreateApiDeploymentRequest

Match All

Show Source

• object CreateApiDeploymentRequest-allOf[0]
• object CreateForm

{
    "allOf":[
        {
            "type":"object",
            "required":[
                "apiId"
            ],
            "properties":{
                "apiId":{
                    "type":"string",
                    "description":"A unique ID referencing a specific API."
                }
            }
        },
        {
            "$ref":"#/definitions/CreateForm"
        }
    ]
}

Nested Schema : CreateApiDeploymentRequest-allOf[0]

Type: object

Show Source

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

{
    "type":"object",
    "required":[
        "apiId"
    ],
    "properties":{
        "apiId":{
            "type":"string",
            "description":"A unique ID referencing a specific API."
        }
    }
}

Nested Schema : CreateForm

Type: object

Show Source

• action: string
  The deployment action. Valid values are DEPLOY (to create a new deployment), UNDEPLOY (to undeploy a deployment), ACTIVATE (to activate a deployment), and INACTIVATE (to inactivate a deployment).
• description(optional): string
  The deployment's description. This is an optional value and is applicable to only the DEPLOY action. If no value is specified and a deployment already exists, it defaults to the existing description.
• iterationId(optional): string
  A unique ID referencing a specific iteration of an API. This is an optional attribute and is applicable to only the DEPLOY action. If unspecified, it defaults to the latest iteration.
• runtimeState(optional): string

  The deployment's runtime state. This is an optional attribute and is applicable to only the DEPLOY action. If the API is being deployed to the gateway for the first time, this attribute defaults to INACTIVE; otherwise, it defaults to the existing deployment state.

  Valid values are ACTIVE and INACTIVE.

{
    "type":"object",
    "required":[
        "action"
    ],
    "properties":{
        "action":{
            "type":"string",
            "description":"The deployment action. Valid values are <code>DEPLOY</code> (to create a new deployment), <code>UNDEPLOY</code> (to undeploy a deployment), <code>ACTIVATE</code> (to activate a deployment), and <code>INACTIVATE</code> (to inactivate a deployment)."
        },
        "iterationId":{
            "type":"string",
            "description":"A unique ID referencing a specific iteration of an API. This is an optional attribute and is applicable to only the <code>DEPLOY</code> action. If unspecified, it defaults to the latest iteration."
        },
        "description":{
            "type":"string",
            "description":"The deployment's description. This is an optional value and is applicable to only the <code>DEPLOY</code> action. If no value is specified and a deployment already exists, it defaults to the existing description."
        },
        "runtimeState":{
            "type":"string",
            "description":"<p>The deployment's runtime state. This is an optional attribute and is applicable to only the <code>DEPLOY</code> action. If the API is being deployed to the gateway for the first time, this attribute defaults to <code>INACTIVE</code>; otherwise, it defaults to the existing deployment state.</p><p>Valid values are <code>ACTIVE</code> and <code>INACTIVE</code>.</p>"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The deployment was created.

Body ()

Root Schema : DeploymentId

Type: object

Show Source

• id: string
  The deployment's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The deployment's ID."
        }
    }
}

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 create a new deployment request for a gateway by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X POST 
-u apicsadmin:password
-H "Content-Type:application/json"
-d @deploy-api.json
https://example.com/apiplatform/management/v1/gateways/{gwId}/deployments

{gwId} is the unique of a gateway. To retrieve available gateway Ids, see Get gateways.

Example of Request Body

The following example shows an example of the request body in JSON format (included with the request above in a file named api-deploy.json) , including the API you want to deploy and details about its deployment.

{"apiId":"103","action":"DEPLOY","description":"","runtimeState":"ACTIVE"}

{apiId} is the unique ID for an API. To retrieve available API IDs, see Get API IDs.

Example of Response Body

The following example shows the contents of the response body in JSON format, including ID of the deployment:

{
    "id": "104"
}

Back to Top