Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

Gets information about a Deployment resource.

get/restapis/{restapi_id}/deployments/{deployment_id}

Path parameters

restapi_idstring required

The string identifier of the associated RestApi.

deployment_idstring required

The identifier of the Deployment resource to get information about.

Query parameters

embedString[]

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this <code>embed</code> parameter value is a list of comma-separated strings, as in <code>GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2</code>. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the <code>"apisummary"</code> string. For example, <code>GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary</code>.

Response

Success

idstring

The identifier for the deployment resource.

descriptionstring

The description for the deployment resource.

createdDatestring date-time

The date and time that the deployment resource was created.

apiSummaryobject

A summary of the RestApi at the date and time that the deployment resource was created.