Gets a list of all Gateways in a compartment
GET {{baseUrl}}/gateways?compartmentId={{compartment_ocid}}&lifecycleState=&limit=100&page=&sortOrder=ASC&sortBy=timeCreated
Returns a list of gateways.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
compartmentId | string | (Required) The ocid of the compartment in which to list resources. | |
certificateId | null | Filter gateways by the certificate ocid. | |
displayName | null | A user-friendly name. Does not have to be unique, and it's changeable. |
Example: My new resource
|
| lifecycleState | null | | A filter to return only resources that match the given lifecycle state.
Example: SUCCEEDED
|
| limit | number | | The maximum number of items to return. |
| page | null | | The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
| sortOrder | string | | The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value. |
| sortBy | string | | 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.
|
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
opc-request-id | null | The client request id for tracing. | |
Date | string | (Required) Current Date | |
Authorization | string | (Required) Signature Authentication on Authorization header |
RESPONSES
status: OK
{"items":[{"endpointType":"do magna","hostname":"qui veniam sint","lifecycleDetails":"adipisicing mollit","lifecycleState":"fugiat proident in"},{"endpointType":"in eiusmod eu","hostname":"Ut mollit","lifecycleDetails":"exercitation labore","lifecycleState":"commodo nostrud aliquip"}]}