openapi: 3.2.0 info: description: 'API for the API Gateway service. Use this API to manage gateways, deployments, and related items. For more information, see [Overview of API Gateway](/iaas/Content/APIGateway/Concepts/apigatewayoverview.htm). ' title: API Gateway API version: '20190501' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/4a7a190925fb30298864e9aee04c85cfd197a64c6eca47f749c72b5d9b9046ba.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the API Gateway API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/4a7a190925fb30298864e9aee04c85cfd197a64c6eca47f749c72b5d9b9046ba.yaml what: the harvested document for API Gateway API servers: - url: http://127.0.0.1/20190501 - url: https://127.0.0.1/20190501 tags: - name: gateway paths: /gateways: get: description: 'Returns a list of gateways. ' operationId: ListGateways parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CertificateIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/GatewayLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of GatewaySummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string default: 'null' opc-prev-page: description: 'For list pagination. When this header appears in the response, additional pages of results were seen previously. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string default: 'null' opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' schema: type: string default: 'null' content: application/json: schema: $ref: '#/components/schemas/GatewayCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Gateways in a compartment tags: - gateway x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/GatewaySummary' post: description: 'Creates a new gateway. ' operationId: CreateGateway parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The gateway is being created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string default: 'null' location: description: 'Location of the resource. ' schema: type: string default: 'null' opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' schema: type: string default: 'null' opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with this id to track the status of the request. ' schema: type: string default: 'null' content: application/json: schema: $ref: '#/components/schemas/Gateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Gateway tags: - gateway x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateGatewayDetails' description: Details for the new gateway. required: true /gateways/{gatewayId}: delete: description: Deletes the gateway with the given identifier. operationId: DeleteGateway parameters: - $ref: '#/components/parameters/GatewayIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OverrideLocksQueryParameter' responses: 202: description: The gateway will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' schema: type: string default: 'null' opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with this id to track the status of the request. ' schema: type: string default: 'null' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned Gateway tags: - gateway x-related-resource: '#/definitions/Gateway' get: description: Gets a gateway by identifier. operationId: GetGateway parameters: - $ref: '#/components/parameters/GatewayIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the gateway with the given identifier. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string default: 'null' opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' schema: type: string default: 'null' content: application/json: schema: $ref: '#/components/schemas/Gateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Gateway tags: - gateway x-obmcs-client-retries-enabled: true put: description: Updates the gateway with the given identifier. operationId: UpdateGateway parameters: - $ref: '#/components/parameters/GatewayIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OverrideLocksQueryParameter' responses: 202: description: The gateway will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' schema: type: string default: 'null' opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with this id to track the status of the request. ' schema: type: string default: 'null' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Gateway by the identifier tags: - gateway x-related-resource: '#/definitions/Gateway' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateGatewayDetails' description: The information to be updated. required: true /gateways/{gatewayId}/actions/addLock: post: description: Adds a lock to a Gateway resource. operationId: AddGatewayLock parameters: - description: 'Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match schema: type: string - $ref: '#/components/parameters/GatewayIdentifierPathParam' - $ref: '#/components/parameters/AddResourceLockDetailsBodyParam' responses: 200: description: Lock is added. headers: etag: description: 'etag for the returned Gateway resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Gateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Adds a lock to a Gateway resource. tags: - gateway x-related-resource: '#/definitions/Gateway' /gateways/{gatewayId}/actions/changeCompartment: post: description: Changes the gateway compartment. operationId: ChangeGatewayCompartment parameters: - $ref: '#/components/parameters/GatewayIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OverrideLocksQueryParameter' responses: 202: description: The gateway's compartment will be changed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' schema: type: string default: 'null' opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with this id to track the status of the request. ' schema: type: string default: 'null' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Change the gateway compartment. tags: - gateway x-related-resource: '#/definitions/Gateway' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeGatewayCompartmentDetails' description: Details of the target compartment. required: true /gateways/{gatewayId}/actions/removeLock: post: description: Removes a lock from a Gateway resource. operationId: RemoveGatewayLock parameters: - description: 'Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match schema: type: string - $ref: '#/components/parameters/GatewayIdentifierPathParam' - $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam' responses: 200: description: Lock is removed. headers: etag: description: 'etag for the returned Gateway resource. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Gateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Removes a lock to a Gateway resource. tags: - gateway x-related-resource: '#/definitions/Gateway' components: schemas: ResourceLock: description: 'Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource. ' properties: message: description: 'A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. ' type: string relatedResourceId: description: 'The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. ' type: string timeCreated: description: When the lock was created. format: date-time type: string type: description: Type of the lock. enum: - FULL - DELETE type: string required: - type type: object Ipv4AddressConfiguration: description: IPv4 address configuration details that should be used when creating the gateway. properties: reservedIpIds: description: List of Reserved IP OCIDs created in VCN service. items: maxLength: 255 minLength: 1 type: string maxItems: 1 minItems: 1 type: array uniqueItems: true type: object GatewayCollection: description: Collection of gateway summaries. properties: items: description: Gateway summaries. items: $ref: '#/components/schemas/GatewaySummary' type: array required: - items type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message type: object RemoveResourceLockDetails: description: 'Used to remove a resource lock. Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource. ' properties: type: description: Type of the lock. enum: - FULL - DELETE type: string required: - type type: object CaBundle: description: Reference to the CA bundle that should be used on the gateway discriminator: propertyName: type properties: type: description: Type of the CA bundle enum: - CA_BUNDLE - CERTIFICATE_AUTHORITY type: string required: - type type: object ChangeGatewayCompartmentDetails: description: The new compartment details for the gateway. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object IpAddress: description: IP address associated with the gateway. properties: ipAddress: description: An IP address. type: string required: - ipAddress type: object ResponseCacheDetails: description: 'Base Gateway response cache. ' discriminator: propertyName: type properties: type: description: Type of the Response Cache. enum: - EXTERNAL_RESP_CACHE - NONE type: string required: - type Gateway: description: 'A gateway is a virtual network appliance in a regional subnet. A gateway routes inbound traffic to back-end services including public, private, and partner HTTP APIs, as well as Oracle Functions. Avoid entering confidential information. For more information, see [API Gateway Concepts](/iaas/Content/APIGateway/Concepts/apigatewayconcepts.htm). ' properties: caBundles: description: An array of CA bundles that should be used on the Gateway for TLS validation. items: $ref: '#/components/schemas/CaBundle' type: array certificateId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource. ' maxLength: 255 minLength: 1 type: string compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' type: string endpointType: description: 'Gateway endpoint type. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be accessible on a private IP address on the subnet. Example: `PUBLIC` or `PRIVATE` ' enum: - PUBLIC - PRIVATE type: string freeformTags: additionalProperties: type: string description: '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](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object hostname: description: The hostname for APIs deployed on the gateway. type: string id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource. ' maxLength: 255 minLength: 1 type: string ipAddresses: description: An array of IP addresses associated with the gateway. items: $ref: '#/components/schemas/IpAddress' type: array ipMode: description: 'Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. `IPV4` means the gateway will only have an IPv4 address assigned to it, and `IPV6` means the gateway will only have an `IPv6` address assigned to it. `DUAL_STACK` means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: `IPV4` or `IPV6` or `DUAL_STACK` ' enum: - IPV4 - IPV6 - DUAL_STACK type: string ipv4AddressConfiguration: $ref: '#/components/schemas/Ipv4AddressConfiguration' ipv6AddressConfiguration: $ref: '#/components/schemas/Ipv6AddressConfiguration' lifecycleDetails: description: '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. ' type: string lifecycleState: description: The current state of the gateway. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array networkSecurityGroupIds: description: 'An array of Network Security Groups OCIDs associated with this API Gateway. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true responseCacheDetails: $ref: '#/components/schemas/ResponseCacheDetails' subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet in which related resources are created. ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - endpointType type: object CreateGatewayDetails: description: Information about the new gateway. properties: caBundles: description: An array of CA bundles that should be used on the Gateway for TLS validation. items: $ref: '#/components/schemas/CaBundle' type: array certificateId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource which can be empty string. ' maxLength: 255 minLength: 0 type: string compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' type: string endpointType: description: 'Gateway endpoint type. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be accessible on a private IP address on the subnet. Example: `PUBLIC` or `PRIVATE` ' type: string x-obmcs-enumref: '#/definitions/Gateway/endpointType' freeformTags: additionalProperties: type: string description: '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](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ipMode: description: 'Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. `IPV4` means the gateway will only have an IPv4 address assigned to it, and `IPV6` means the gateway will only have an `IPv6` address assigned to it. `DUAL_STACK` means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: `IPV4` or `IPV6` or `DUAL_STACK` ' type: string x-obmcs-enumref: '#/definitions/Gateway/ipMode' ipv4AddressConfiguration: $ref: '#/components/schemas/Ipv4AddressConfiguration' ipv6AddressConfiguration: $ref: '#/components/schemas/Ipv6AddressConfiguration' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/AddResourceLockDetails' maxItems: 1 type: array networkSecurityGroupIds: description: 'An array of Network Security Groups OCIDs associated with this API Gateway. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true responseCacheDetails: $ref: '#/components/schemas/ResponseCacheDetails' subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet in which related resources are created. ' maxLength: 255 minLength: 1 type: string required: - endpointType - compartmentId - subnetId type: object GatewaySummary: description: A summary of the gateway. properties: certificateId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource. ' maxLength: 255 minLength: 1 type: string compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' type: string endpointType: description: 'Gateway endpoint type. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be accessible on a private IP address on the subnet. Example: `PUBLIC` or `PRIVATE` ' type: string x-obmcs-enumref: '#/definitions/Gateway/endpointType' freeformTags: additionalProperties: type: string description: '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](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object hostname: description: The hostname for the APIs deployed on the gateway. type: string id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource. ' maxLength: 255 minLength: 1 type: string ipMode: description: 'Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. `IPV4` means the gateway will only have an IPv4 address assigned to it, and `IPV6` means the gateway will only have an `IPv6` address assigned to it. `DUAL_STACK` means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: `IPV4` or `IPV6` or `DUAL_STACK` ' type: string x-obmcs-enumref: '#/definitions/Gateway/ipMode' lifecycleDetails: description: '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. ' type: string lifecycleState: description: The current state of the gateway. type: string x-obmcs-enumref: '#/definitions/Gateway/lifecycleState' locks: description: Locks associated with this resource. items: $ref: '#/components/schemas/ResourceLock' maxItems: 2 type: array networkSecurityGroupIds: description: 'An array of Network Security Groups OCIDs associated with this API Gateway. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet in which related resources are created. ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - endpointType type: object AddResourceLockDetails: description: 'Used to add a resource lock. Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource. ' properties: message: description: 'A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. ' type: string type: description: Type of the lock. enum: - FULL - DELETE type: string required: - type type: object UpdateGatewayDetails: description: The information to be updated. properties: caBundles: description: An array of CA bundles that should be used on the Gateway for TLS validation. items: $ref: '#/components/schemas/CaBundle' type: array certificateId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource which can be empty string. ' maxLength: 255 minLength: 0 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' type: string freeformTags: additionalProperties: type: string description: '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](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object networkSecurityGroupIds: description: 'An array of Network Security Groups OCIDs associated with this API Gateway. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true responseCacheDetails: $ref: '#/components/schemas/ResponseCacheDetails' type: object Ipv6AddressConfiguration: description: IPv6 address configuration details that should be used when creating the gateway. properties: addresses: description: List of IPv6 addresses that will be assigned to the gateway during creation. items: maxLength: 45 minLength: 1 type: string maxItems: 1 minItems: 1 type: array uniqueItems: true subnetCidrs: description: List of IPv6 prefixes from which to provision IPv6 addresses from. This is required if more than one prefix exists on the subnet. items: maxLength: 45 minLength: 1 type: string maxItems: 1 minItems: 1 type: array type: object parameters: PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page schema: type: string default: 'null' maxLength: 1024 minLength: 1 AddResourceLockDetailsBodyParam: description: AddResourceLockDetails body parameter in: body name: AddResourceLockDetails required: true schema: $ref: '#/components/schemas/AddResourceLockDetails' SortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for `timeCreated` is descending. Default order for `displayName` is ascending. The `displayName` sort order is case sensitive. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated GatewayLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. Example: `SUCCEEDED` ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/Gateway/lifecycleState' schema: type: string default: 'null' CompartmentIdQueryParam: description: The ocid of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match schema: type: string default: 'null' GatewayIdentifierPathParam: description: The ocid of the gateway. in: path name: gatewayId required: true schema: type: string RemoveResourceLockDetailsBodyParam: description: RemoveResourceLockDetails body parameter in: body name: RemoveResourceLockDetails required: true schema: $ref: '#/components/schemas/RemoveResourceLockDetails' CertificateIdQueryParam: description: Filter gateways by the certificate ocid. in: query name: certificateId schema: type: string default: 'null' PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 SortOrderQueryParam: description: The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value. in: query name: sortOrder schema: type: string enum: - ASC - DESC default: ASC RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token schema: type: string default: 'null' maxLength: 64 minLength: 1 OverrideLocksQueryParameter: description: Whether to override locks (if any exist). in: query name: isLockOverride schema: type: boolean default: false DisplayNameQueryParam: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Example: `My new resource` ' in: query name: displayName schema: type: string default: 'null' maxLength: 255 minLength: 1 RequestIdHeader: description: The client request id for tracing. in: header name: opc-request-id schema: type: string default: 'null' responses: default: description: UnknownError headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' schema: type: string default: 'null' content: application/json: schema: $ref: '#/components/schemas/Error' DefaultError: description: UnknownError headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' schema: type: string default: 'null' content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: default: 'null' description: 'For optimistic concurrency control. See `if-match`. ' type: string location: default: 'null' description: 'Location of the resource. ' type: string opc-next-page: default: 'null' description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-prev-page: default: 'null' description: 'For list pagination. When this header appears in the response, additional pages of results were seen previously. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: default: 'null' description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request id. ' type: string opc-work-request-id: default: 'null' description: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with this id to track the status of the request. ' type: string retry-after: description: 'A decimal number representing the number of seconds the client should wait before polling this endpoint again. ' format: integer type: number x-properties: apiOcid: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of API resource ' maxLength: 255 minLength: 1 type: string compartmentOcid: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object deploymentOcid: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of a deployment resource. ' maxLength: 255 minLength: 1 type: string description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' type: string emptyableOcid: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource which can be empty string. ' maxLength: 255 minLength: 0 type: string freeformTags: additionalProperties: type: string description: '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](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object functionOcid: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. ' maxLength: 255 minLength: 1 type: string networkSecurityGroupOcids: description: 'An array of Network Security Groups OCIDs associated with this API Gateway. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true ocid: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the resource. ' maxLength: 255 minLength: 1 type: string secretOcid: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. ' maxLength: 255 minLength: 1 type: string subnetOcid: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet in which related resources are created. ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string usagePlanOcid: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of a usage plan resource. ' maxLength: 255 minLength: 1 type: string x-oracle-package: com.oracle.pic.apigw