Gets a list of Endpoints.
GET {{baseUrl}}/endpoints?compartmentId={{compartment_ocid}}&limit=10&sortOrder=ASC&sortBy=timeCreated
Pre-General Availability: 2023-09-18 |Important| |- |The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see Oracle Legal Notices.
| Pre-General Availability Draft Documentation Notice |
|---|
| This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation. This documentation is not a commitment by Oracle to deliver any material, code, functionality or services. This documentation, and Oracle Pre-GA programs and services are subject to change at any time without notice and, accordingly, should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality for Oracle’s Pre-GA programs and services remains at the sole discretion of Oracle. All release dates or other predictions of future events are subject to change. The future availability of any future Oracle program or service should not be relied on in entering into any license or service agreement with Oracle. |
ListEndpoints
List the endpoints of a specific compartment.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
compartmentId | string | (Required) The OCID of the compartment in which to list resources. | |
lifecycleState | string | A filter to return only resources their lifecycleState matches the given lifecycleState. | |
displayName | string | A filter to return only resources that match the given display name exactly. | |
id | string | The OCID of the Endpoint. | |
limit | number | For list pagination. The maximum number of results per page, or items to return in a | |
| paginated "List" call. For important details about how pagination works, see | |||
| List Pagination. | |||
page | string | For list pagination. The value of the opc-next-page response header from the previous | |
| "List" call. For important details about how pagination works, see | |||
| List Pagination. | |||
sortOrder | string | The sort order to use, either 'ASC' or 'DESC'. | |
sortBy | string | The field to sort by. You can provide only one sort order. Default order for timeCreated | |
is descending. Default order for displayName is ascending. | |||
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
opc-request-id | string | Unique Oracle-assigned identifier for the request. If you need to contact | |
| Oracle about a particular request, please provide the request ID. | |||
| The only valid characters for request IDs are letters, numbers, | |||
| underscore, and dash. | |||
Accept | string |
RESPONSES
status: OK
{"items":[{"id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","lifecycleState":"\u003cstring\u003e","timeCreated":"\u003cdateTime\u003e","modelId":"\u003cstring\u003e","dedicatedAiClusterId":"\u003cstring\u003e","definedTags":{"qui_a":{"exercitation6d":{},"est_8e3":{}},"laboris_2":{"in7":{},"velit_80":{},"nisic1":{}}},"description":"\u003cstring\u003e","displayName":"\u003cstring\u003e","freeformTags":{"aliquip_79":"\u003cstring\u003e","fugiatfeb":"\u003cstring\u003e","Lorem4d":"\u003cstring\u003e"},"lifecycleDetails":"\u003cstring\u003e","systemTags":{"labore0":{"mollite81":{}}},"timeUpdated":"\u003cdateTime\u003e"},{"id":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","lifecycleState":"\u003cstring\u003e","timeCreated":"\u003cdateTime\u003e","modelId":"\u003cstring\u003e","dedicatedAiClusterId":"\u003cstring\u003e","definedTags":{"Lorem0":{"mollitca":{}},"sede73":{"laboris__":{},"in13":{},"cupidatat_bf":{}}},"description":"\u003cstring\u003e","displayName":"\u003cstring\u003e","freeformTags":{"Excepteur_3":"\u003cstring\u003e","reprehenderit_d5":"\u003cstring\u003e","reprehenderit4a9":"\u003cstring\u003e"},"lifecycleDetails":"\u003cstring\u003e","systemTags":{"sed_1c_":{"do_e5a":{},"doa7e":{}}},"timeUpdated":"\u003cdateTime\u003e"}]}