{ "opencollection": "1.0.0", "info": { "name": "Control Plane Private Service Access API", "version": "20240301" }, "items": [ { "info": { "name": "privateServiceAccess", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of PrivateServiceAccess.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240301/privateServiceAccess", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource." }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." }, { "name": "serviceId", "value": "", "type": "query", "description": "The unique identifier of the OCI service." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending. \n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "List the Private Service Access endpoints in the specified compartment. You can optionally filter the list by\nspecifying the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a subnet in the VCN.\n" }, { "info": { "name": "Creates a PrivateServiceAccess.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240301/privateServiceAccess", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Private Service Access endpoint in the specified subnet (in the VCN) and the specified\ncompartment for a particular service.\n" }, { "info": { "name": "Get PrivateServiceAccess", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240301/privateServiceAccess/:privateServiceAccessId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "privateServiceAccessId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `PrivateServiceAccess` object." } ] }, "docs": "Gets information about a Private Service Access endpoint." }, { "info": { "name": "Updates a PrivateServiceAccess.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20240301/privateServiceAccess/:privateServiceAccessId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "privateServiceAccessId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `PrivateServiceAccess` object." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Private Service Access endpoint." }, { "info": { "name": "Deletes a PrivateServiceAccess.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20240301/privateServiceAccess/:privateServiceAccessId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "privateServiceAccessId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `PrivateServiceAccess` object." } ] }, "docs": "Deletes a Private Service Access endpoint." }, { "info": { "name": "Moves a PrivateServiceAccess into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240301/privateServiceAccess/:privateServiceAccessId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "privateServiceAccessId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `PrivateServiceAccess` object." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Private Service Access endpoint to a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Lists PsaServiceSummary.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240301/psaServices", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "serviceId", "value": "", "type": "query", "description": "The unique identifier of the OCI service." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `displayName` is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "List the OCI services available in the Private Service Access catalog for the region, sorted by service name.\n" }, { "info": { "name": "List PSA work requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240301/psaWorkRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only the resources that match the given lifecycle state." }, { "name": "resourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.\n" } ] }, "docs": "Lists the PrivateServiceAccess work requests in a compartment.\n" }, { "info": { "name": "Get PSA work request status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240301/psaWorkRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." } ] }, "docs": "Gets the details of a PrivateServiceAccess work request." }, { "info": { "name": "Cancel PSA work request", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20240301/psaWorkRequests/:workRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." } ] }, "docs": "Cancels a PrivateServiceAccess work request." }, { "info": { "name": "List PSA work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240301/psaWorkRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "Lists the errors for a PrivateServiceAccess work request.\n" }, { "info": { "name": "List PSA work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240301/psaWorkRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "Lists the logs for a PrivateServiceAccess work request.\n" } ] } ], "bundled": true }