Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Deployment

A deployment deploys an API on a gateway. Avoid entering confidential information. For more information, see API Gateway Concepts.

Properties

compartmentId

compartmentId: string

The OCID of the compartment in which the resource is created.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional displayName

displayName: undefined | string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Example: {@code My new resource}

endpoint

endpoint: string

The endpoint to access this deployment on the gateway.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {@code {\"Department\": \"Finance\"}}

gatewayId

gatewayId: string

The OCID of the resource.

id

id: string

The OCID of the resource.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the deployment.

pathPrefix

pathPrefix: string

A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.

specification

specification: ApiSpecification

Optional timeCreated

timeCreated: Date

The time this resource was created. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

The time this resource was last updated. An RFC3339 formatted datetime string.

Functions

getDeserializedJsonObj

getJsonObj